OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.AvailabilitySearch
Implementsosid.OsidSearch
Description

The search interface for governing availability searches.

MethodsearchAmongAvailabilities
Description

Execute this search among the given list of availabilities.

Parametersosid.id.IdListavailabilityIdslist of availabilities
ErrorsNULL_ARGUMENT availabilityIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAvailabilityResults
Description

Specify an ordering to the search results.

Parametersosid.resourcing.AvailabilitySearchOrderavailabilitySearchOrderavailability search order
ErrorsNULL_ARGUMENT availabilitySearchOrder is null
UNSUPPORTED availabilitySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilitySearchRecord
Description

Gets the availability search 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.AvailabilitySearchRecordthe availability search record
ErrorsNULL_ARGUMENT availabilitySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(availabilitySearchRecordType) is false
CompliancemandatoryThis method must be implemented.