OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.rules.HoldEnablerSearch
Implementsosid.OsidSearch
Description

The search interface for governing hold enabler searches.

MethodsearchAmongHoldEnablers
Description

Execute this search among the given list of hold enablers.

Parametersosid.id.IdListholdEnablerIdslist of hold enablers
ErrorsNULL_ARGUMENT holdEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderHoldEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.hold.rules.HoldEnablerSearchOrderholdEnablerSearchOrderhold enabler search order
ErrorsNULL_ARGUMENT holdEnablerSearchOrder is null
UNSUPPORTED holdEnablerSearchOrder is not of this service
CompliancemandatoryThis 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.TypeholdEnablerSearchRecordTypea hold enabler search record type
Returnosid.hold.rules.records.HoldEnablerSearchRecordthe hold enabler search record
ErrorsNULL_ARGUMENT holdEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(holdEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.