OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.AvailabilitySearchResults
Implementsosid.OsidSearchResults
Used Byosid.resourcing.AvailabilitySearchSession
Description

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

MethodgetAvailabilities
Description

Gets the availability list resulting from a search.

Returnosid.resourcing.AvailabilityList the availability list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetAvailabilityQueryInspector
Description

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

Returnosid.resourcing.AvailabilityQueryInspector the availability query inspector
Compliancemandatory This 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.TypeavailabilitySearchRecordType an availability search record type
Returnosid.resourcing.records.AvailabilitySearchResultsRecord the availability search results record
ErrorsNULL_ARGUMENT availabilitySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(availabilitySearchRecordType) is false
Compliancemandatory This method must be implemented.