OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.HoldSearchResults
Implementsosid.OsidSearchResults
Used Byosid.hold.HoldSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetHolds
Description

Gets the hold list resulting from a search.

Returnosid.hold.HoldList the hold list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetHoldQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.hold.HoldQueryInspector the hold query inspector
Compliancemandatory This method must be implemented.
MethodgetHoldSearchResultsRecord
Description

Gets the hold search results 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.HoldSearchResultsRecord the hold search results 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.