OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.AvailabilitySearch
Implementsosid.OsidSearch
Used Byosid.resourcing.AvailabilitySearchSession
Description

The search interface for governing availability searches.

MethodsearchAmongAvailabilities
Description

Execute this search among the given list of availabilities.

Parametersosid.id.IdListavailabilityIds list of availabilities
ErrorsNULL_ARGUMENT availabilityIds is null
Compliancemandatory This method must be implemented.
MethodorderAvailabilityResults
Description

Specify an ordering to the search results.

Parametersosid.resourcing.AvailabilitySearchOrderavailabilitySearchOrder availability search order
ErrorsNULL_ARGUMENT availabilitySearchOrder is null
UNSUPPORTED availabilitySearchOrder is not of this service
Compliancemandatory This 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.TypeavailabilitySearchRecordType an availability search record type
Returnosid.resourcing.records.AvailabilitySearchRecord the availability search record
ErrorsNULL_ARGUMENT availabilitySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(availabilitySearchRecordType) is false
Compliancemandatory This method must be implemented.