OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.JobProcessorSearchSession
Implementsosid.resourcing.rules.JobProcessorQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

JobProcessors may have a job processor query record indicated by their respective record types. The job processor query record is accessed via the JobProcessorQuery.

MethodgetJobProcessorSearch
Description

Gets a job processor search.

Returnosid.resourcing.rules.JobProcessorSearchthe job processor search
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorSearchOrder
Description

Gets a job processor search order. The JobProcessorSearchOrder is supplied to a JobProcessorSearch to specify the ordering of results.

Returnosid.resourcing.rules.JobProcessorSearchOrderthe job processor search order
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorsBySearch
Description

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

Parametersosid.resourcing.rules.JobProcessorQueryjobProcessorQuerythe job processor query
osid.resourcing.rules.JobProcessorSearchjobProcessorSearchthe job processor search
Returnosid.resourcing.rules.JobProcessorSearchResultsthe returned search results
ErrorsNULL_ARGUMENT jobProcessorQuery or jobProcessorSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED jobProcessorQuery or jobProcessorSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorQueryFromInspector
Description

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

Parametersosid.resourcing.rules.JobProcessorQueryInspectorjobProcessorQueryInspectora job processor query inspector
Returnosid.resourcing.rules.JobProcessorQuerythe job processor query
ErrorsNULL_ARGUMENT jobProcessorQueryInspector is null
UNSUPPORTED jobProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.