OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.HoldSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetHolds
Description

Gets the hold list resulting from a search.

Returnosid.hold.HoldListthe hold list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetHoldQueryInspector
Description

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

Returnosid.hold.HoldQueryInspectorthe hold query inspector
CompliancemandatoryThis 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.TypeholdSearchRecordTypea hold search record type
Returnosid.hold.records.HoldSearchResultsRecordthe hold search results 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.