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

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

MethodgetAvailabilities
Description

Gets the availability list resulting from a search.

Returnosid.resourcing.AvailabilityListthe availability list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityQueryInspector
Description

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

Returnosid.resourcing.AvailabilityQueryInspectorthe availability query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilitySearchResultsRecord
Description

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

Parametersosid.type.TypeavailabilitySearchRecordTypean availability search record type
Returnosid.resourcing.records.AvailabilitySearchResultsRecordthe availability search results record
ErrorsNULL_ARGUMENT availabilitySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(availabilitySearchRecordType) is false
CompliancemandatoryThis method must be implemented.