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

The search interface for governing hold searches.

MethodsearchAmongHolds
Description

Execute this search among the given list of holds.

Parametersosid.id.IdListholdIdslist of holds
ErrorsNULL_ARGUMENT holdIds is null
CompliancemandatoryThis method must be implemented.
MethodorderHoldResults
Description

Specify an ordering to the search results.

Parametersosid.hold.HoldSearchOrderholdSearchOrderhold search order
ErrorsNULL_ARGUMENT holdSearchOrder is null
UNSUPPORTED holdSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetHoldSearchRecord
Description

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

Parametersosid.type.TypeholdSearchRecordTypea hold search record type
Returnosid.hold.records.HoldSearchRecordthe hold search record
ErrorsNULL_ARGUMENT holdSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(holdSearchRecordType) is false
CompliancemandatoryThis method must be implemented.