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

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

MethodgetHoldEnablers
Description

Gets the HoldEnablerList resulting from a search.

Returnosid.hold.rules.HoldEnablerListthe hold enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerQueryInspector
Description

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

Returnosid.hold.rules.HoldEnablerQueryInspectorthe hold enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerSearchResultsRecord
Description

Gets the hold enabler search results record corresponding to the given hold enabler search record Type. This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypeholdEnablerSearchRecordTypea hold enabler search record type
Returnosid.hold.rules.records.HoldEnablerSearchResultsRecordthe hold enabler search results record
ErrorsNULL_ARGUMENT holdEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(holdEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.