OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.AvailabilityEnablerSearchSession
Implementsosid.resourcing.rules.AvailabilityEnablerQuerySession
Description

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

getAvailabilityEnablersByQuery() is the basic search method and returns a list of AvailabilityEnablers. A more advanced search may be performed with getAvailabilityEnablersBySearch(). It accepts an AvailabilityEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. getAvailabilityEnablersBySearch() returns an AvailabilityEnablerSearchResults that can be used to access the resulting AvailabilityEnablerList or be used to perform a search within the result set through AvailabilityEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

AvailabilityEnablers may have an availability enabler query record indicated by their respective record types. The availability enabler record query is accessed via the AvailabilityEnablerQuery.

MethodgetAvailabilityEnablerSearch
Description

Gets an availability enabler search.

Returnosid.resourcing.rules.AvailabilityEnablerSearchthe availability enabler search.
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityEnablerSearchOrder
Description

Gets an availability enabler search order. The AvailabilityEnablerSearchOrder is supplied to an AvailabilityEnablerSearch to specify the ordering of results.

Returnosid.resourcing.rules.AvailabilityEnablerSearchOrderthe availability enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityEnablersBySearch
Description

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

Parametersosid.resourcing.rules.AvailabilityEnablerQueryavailabilityEnablerQuerythe availability enabler query
osid.resourcing.rules.AvailabilityEnablerSearchavailabilityEnablerSearchthe availability enabler search
Returnosid.resourcing.rules.AvailabilityEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT availabilityEnablerQuery or availabilityEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED availabilityEnablerQuery or availabilityEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityEnablerQueryFromInspector
Description

Gets an availability enabler query from an inspector. The inspector is available from an AvailabilityEnablerSearchResults.

Parametersosid.resourcing.rules.AvailabilityEnablerQueryInspectoravailabilityEnablerQueryInspectoran availability enabler query inspector
Returnosid.resourcing.rules.AvailabilityEnablerQuerythe availability enabler query
ErrorsNULL_ARGUMENT availabilityEnablerQueryInspector is null
UNSUPPORTED availabilityEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.