OSID Logo
OSID Specifications
hold rules package
Version 3.1.0
Interfaceosid.hold.rules.HoldEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.hold.rules.HoldEnablerSearchSession
Description

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

MethodgetHoldEnablers
Description

Gets the HoldEnablerList resulting from a search.

Returnosid.hold.rules.HoldEnablerList the hold enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetHoldEnablerQueryInspector
Description

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

Returnosid.hold.rules.HoldEnablerQueryInspector the hold enabler query inspector
Compliancemandatory This 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.TypeholdEnablerSearchRecordType a hold enabler search record type
Returnosid.hold.rules.records.HoldEnablerSearchResultsRecord the hold enabler search results record
ErrorsNULL_ARGUMENT holdEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(holdEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.