OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.AvailabilitySearchSession
Implementsosid.resourcing.AvailabilityQuerySession
Description

This session provides methods for searching among Availability objects. The search query is constructed using the AvailabilityQuery.

getAvailabilitiesByQuery() is the basic search method and returns a list of Availabilities. A more advanced search may be performed with getAvailabilitiesBySearch(). It accepts an AvailabilitySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAvailabilitiesBySearch() returns an AvailabilitySearchResults that can be used to access the resulting AvailabilityList or be used to perform a search within the result set through AvailabilitySearch.

This session defines views that offer differing behaviors for searching.

  • federated foundry view: searches include availabilities in foundries of which this foundry is an ancestor in the foundry hierarchy
  • isolated foundry view: searches are restricted to availabilities in this foundry

Availabilitys may have a query record indicated by their respective record types. The query record is accessed via the AvailabilityQuery.

MethodgetAvailabilitySearch
Description

Gets an availability search.

Returnosid.resourcing.AvailabilitySearchthe availability search
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilitySearchOrder
Description

Gets an availability search order. The AvailabilitySearchOrder is supplied to an AvailabilitySearch to specify the ordering of results.

Returnosid.resourcing.AvailabilitySearchOrderthe availability search order
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilitiesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.resourcing.AvailabilityQueryavailabilityQuerythe availability query
osid.resourcing.AvailabilitySearchavailabilitySearchthe availability search
Returnosid.resourcing.AvailabilitySearchResultsthe returned search results
ErrorsNULL_ARGUMENT availabilityQuery or availabilitySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED availabilityQuery or availabilitySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityQueryFromInspector
Description

Gets an availability query from an inspector. The inspector is available from an AvailabilitySearchResults.

Parametersosid.resourcing.AvailabilityQueryInspectoravailabilityQueryInspectoran availability query inspector
Returnosid.resourcing.AvailabilityQuerythe availability query
ErrorsNULL_ARGUMENT availabilityQueryInspector is null
UNSUPPORTED availabilityQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.