OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.AvailabilityEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetAvailabilityEnablers
Description

Gets the AvailabilityEnablerList resulting from a search.

Returnosid.resourcing.rules.AvailabilityEnablerListthe availability enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityEnablerQueryInspector
Description

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

Returnosid.resourcing.rules.AvailabilityEnablerQueryInspectorthe availability enabler query inspector
CompliancemandatoryThis 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.TypeavailabilityEnablerSearchRecordTypean availability enabler search record type
Returnosid.resourcing.rules.records.AvailabilityEnablerSearchResultsRecordthe availability enabler search results record
ErrorsNULL_ARGUMENT availabilityEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(availabilityEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.