OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.JobSearchSession
Implementsosid.resourcing.JobQuerySession
Description

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

getJobsByQuery() is the basic search method and returns a list of Jobs. A more advanced search may be performed with getJobsBySearch(). It accepts a JobSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getJobsBySearch() returns a JobSearchResults that can be used to access the resulting JobList or be used to perform a search within the result set through JobSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetJobSearch
Description

Gets a job search.

Returnosid.resourcing.JobSearchthe job search
CompliancemandatoryThis method must be implemented.
MethodgetJobSearchOrder
Description

Gets a job search order. The JobSearchOrder is supplied to a JobSearch to specify the ordering of results.

Returnosid.resourcing.JobSearchOrderthe job search order
CompliancemandatoryThis method must be implemented.
MethodgetJobsBySearch
Description

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

Parametersosid.resourcing.JobQueryjobQuerythe job query
osid.resourcing.JobSearchjobSearchthe job search
Returnosid.resourcing.JobSearchResultsthe returned search results
ErrorsNULL_ARGUMENT jobQuery or jobSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED jobQuery or jobSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetJobQueryFromInspector
Description

Gets a job query from an inspector. The inspector is available from a JobSearchResults.

Parametersosid.resourcing.JobQueryInspectorjobQueryInspectora job query inspector
Returnosid.resourcing.JobQuerythe job query
ErrorsNULL_ARGUMENT jobQueryInspector is null
UNSUPPORTED jobQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.