OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.JobProcessorEnablerSearchSession
Implementsosid.resourcing.rules.JobProcessorEnablerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetJobProcessorEnablerSearch
Description

Gets a job processor enabler search.

Returnosid.resourcing.rules.JobProcessorEnablerSearchthe job processor enabler search
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorEnablerSearchOrder
Description

Gets a job processor enabler search order. The JobProcessorEnablerSearchOrder is supplied to a JobProcessorEnablerSearch to specify the ordering of results.

Returnosid.resourcing.rules.JobProcessorEnablerSearchOrderthe job processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorEnablersBySearch
Description

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

Parametersosid.resourcing.rules.JobProcessorEnablerQueryjobProcessorEnablerQuerythe job processor enabler query
osid.resourcing.rules.JobProcessorEnablerSearchjobProcessorEnablerSearchthe job processor enabler search
Returnosid.resourcing.rules.JobProcessorEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT jobProcessorEnablerQuery or jobProcessorEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED jobProcessorEnablerQuery or jobProcessorEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorEnablerQueryFromInspector
Description

Gets a job processor enabler query from an inspector. The inspector is available from a JobProcessorEnablerSearchResults.

Parametersosid.resourcing.rules.JobProcessorEnablerQueryInspectorjobProcessorEnablerQueryInspectora job processor enabler query inspector
Returnosid.resourcing.rules.JobProcessorEnablerQuerythe job processor enabler query
ErrorsNULL_ARGUMENT jobProcessorEnablerQueryInspector is null
UNSUPPORTED jobProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.