OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ValueEnablerSearch
Implementsosid.OsidSearch
Description

The search interface for governing value enabler searches.

MethodsearchAmongValueEnablers
Description

Execute this search among the given list of value enablers.

Parametersosid.id.IdListvalueEnablerIdslist of value enablers
ErrorsNULL_ARGUMENT valueEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderValueEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.configuration.rules.ValueEnablerSearchOrdervalueEnablerSearchOrdervalue enabler search order
ErrorsNULL_ARGUMENT valueEnablerSearchOrder is null
UNSUPPORTED valueEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetValueEnablerSearchRecord
Description

Gets the value enabler search record corresponding to the given value enabler search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypevalueEnablerSearchRecordTypea value enabler search record type
Returnosid.configuration.rules.records.ValueEnablerSearchRecordthe value enabler search record
ErrorsNULL_ARGUMENT valueEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(valueEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.