public interface JobSearchSession extends JobQuerySession
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.
Jobs may have a query record indicated by their respective record
types. The query record is accessed via the JobQuery.
Modifier and Type | Method and Description |
---|---|
JobQuery |
getJobQueryFromInspector(JobQueryInspector jobQueryInspector)
Gets a job query from an inspector.
|
JobSearchResults |
getJobsBySearch(JobQuery jobQuery,
JobSearch jobSearch)
Gets the search results matching the given search query using the
given search.
|
JobSearch |
getJobSearch()
Gets a job search.
|
JobSearchOrder |
getJobSearchOrder()
Gets a job search order.
|
canSearchJobs, getFoundry, getFoundryId, getJobQuery, getJobsByQuery, useFederatedFoundryView, useIsolatedFoundryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
JobSearch getJobSearch()
mandatory
- This method must be implemented. JobSearchOrder getJobSearchOrder()
JobSearchOrder
is supplied
to a JobSearch
to specify the ordering of results.mandatory
- This method must be implemented. JobSearchResults getJobsBySearch(JobQuery jobQuery, JobSearch jobSearch) throws OperationFailedException, PermissionDeniedException
jobQuery
- the job queryjobSearch
- the job searchNullArgumentException
- jobQuery
or
jobSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- jobQuery
or
jobSearch
is not of this servicemandatory
- This method must be implemented. JobQuery getJobQueryFromInspector(JobQueryInspector jobQueryInspector)
JobSearchResults.
jobQueryInspector
- a job query inspectorNullArgumentException
- jobQueryInspector
is null
UnsupportedException
- jobQueryInspector
is not of this servicemandatory
- This method must be implemented.