OSID Logo
OSID Specifications
resourcing rules package
Version 3.1.0
Interfaceosid.resourcing.rules.AvailabilityEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.resourcing.rules.AvailabilityEnablerSearchSession
Description

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

MethodgetAvailabilityEnablers
Description

Gets the AvailabilityEnablerList resulting from a search.

Returnosid.resourcing.rules.AvailabilityEnablerList the availability enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetAvailabilityEnablerQueryInspector
Description

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

Returnosid.resourcing.rules.AvailabilityEnablerQueryInspector the availability enabler query inspector
Compliancemandatory This method must be implemented.
MethodgetAvailabilityEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypeavailabilityEnablerSearchRecordType an availability enabler search record type
Returnosid.resourcing.rules.records.AvailabilityEnablerSearchResultsRecord the availability enabler search results record
ErrorsNULL_ARGUMENT availabilityEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(availabilityEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.