OSID Logo
OSID Specifications
hold rules package
Version 3.1.0
Interfaceosid.hold.rules.HoldEnablerSearch
Implementsosid.OsidSearch
Used Byosid.hold.rules.HoldEnablerSearchSession
Description

The search interface for governing hold enabler searches.

MethodsearchAmongHoldEnablers
Description

Execute this search among the given list of hold enablers.

Parametersosid.id.IdListholdEnablerIds list of hold enablers
ErrorsNULL_ARGUMENT holdEnablerIds is null
Compliancemandatory This method must be implemented.
MethodorderHoldEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.hold.rules.HoldEnablerSearchOrderholdEnablerSearchOrder hold enabler search order
ErrorsNULL_ARGUMENT holdEnablerSearchOrder is null
UNSUPPORTED holdEnablerSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetHoldEnablerSearchRecord
Description

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

Parametersosid.type.TypeholdEnablerSearchRecordType a hold enabler search record type
Returnosid.hold.rules.records.HoldEnablerSearchRecord the hold enabler search record
ErrorsNULL_ARGUMENT holdEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(holdEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.