OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.HoldSearch
Implementsosid.OsidSearch
Used Byosid.hold.HoldSearchSession
Description

The search interface for governing hold searches.

MethodsearchAmongHolds
Description

Execute this search among the given list of holds.

Parametersosid.id.IdListholdIds list of holds
ErrorsNULL_ARGUMENT holdIds is null
Compliancemandatory This method must be implemented.
MethodorderHoldResults
Description

Specify an ordering to the search results.

Parametersosid.hold.HoldSearchOrderholdSearchOrder hold search order
ErrorsNULL_ARGUMENT holdSearchOrder is null
UNSUPPORTED holdSearchOrder is not of this service
Compliancemandatory This 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.TypeholdSearchRecordType a hold search record type
Returnosid.hold.records.HoldSearchRecord the hold search record
ErrorsNULL_ARGUMENT holdSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(holdSearchRecordType) is false
Compliancemandatory This method must be implemented.