OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.JobConstrainerEnablerSearchSession
Implementsosid.resourcing.rules.JobConstrainerEnablerQuerySession
Description

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

getJobConstrainerEnablersByQuery() is the basic search method and returns a list of JobConstrainerEnablers. A more advanced search may be performed with getJobConstrainerEnablersBySearch(). It accepts a JobConstrainerEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. getJobConstrainerEnablersBySearch() returns a JobConstrainerEnablerSearchResults that can be used to access the resulting JobConstrainerEnablerList or be used to perform a search within the result set through JobConstrainerEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

JobConstrainerEnablers may have a job constrainer enabler query record indicated by their respective record types. The job constrainer enabler query record is accessed via the JobConstrainerEnablerQuery.

MethodgetJobConstrainerEnablerSearch
Description

Gets a job constrainer enabler search.

Returnosid.resourcing.rules.JobConstrainerEnablerSearchthe job constrainer enabler search
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainerEnablerSearchOrder
Description

Gets a job constrainer enabler search order. The JobConstrainerEnablerSearchOrder is supplied to a JobConstrainerEnablerSearch to specify the ordering of results.

Returnosid.resourcing.rules.JobConstrainerEnablerSearchOrderthe job constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainerEnablersBySearch
Description

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

Parametersosid.resourcing.rules.JobConstrainerEnablerQueryjobConstrainerEnablerQuerythe job constrainer enabler query
osid.resourcing.rules.JobConstrainerEnablerSearchjobConstrainerEnablerSearchthe job constrainer enabler search
Returnosid.resourcing.rules.JobConstrainerEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT jobConstrainerEnablerQuery or jobConstrainerEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED jobConstrainerEnablerQuery or jobConstrainerEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainerEnablerQueryFromInspector
Description

Gets a job constrainer enabler query from an inspector. The inspector is available from a JobConstrainerEnablerSearchResults.

Parametersosid.resourcing.rules.JobConstrainerEnablerQueryInspectorjobConstrainerEnablerQueryInspectora job constrainer enabler query inspector
Returnosid.resourcing.rules.JobConstrainerEnablerQuerythe job constrainer enabler query
ErrorsNULL_ARGUMENT jobConstrainerEnablerQueryInspector is null
UNSUPPORTED jobConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.