public interface JobConstrainerSearchSession extends JobConstrainerQuerySession
This session provides methods for searching among JobConstrainer
objects. The search query is constructed using the
JobConstraineryQuery.
getJobConstrainersByQuery()
is the basic search method
and returns a list of JobConstrainers.
A more advanced
search may be performed with getJobConstrainersBySearch().
It accepts a JobConstrainerSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as resourcing. getJobConstrainersBySearch()
returns a JobConstrainerSearchResults
that can be used to
access the resulting JobConstrainerList
or be used to
perform a search within the result set through
JobConstrainerSearch.
This session defines views that offer differing behaviors for searching.
JobConstrainers
may have a job constrainer query record
indicated by their respective record types. The job constrainer query
record is accessed via the JobConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
JobConstrainerQuery |
getJobConstrainerQueryFromInspector(JobConstrainerQueryInspector jobConstrainerQueryInspector)
Gets a job constrainer query from an inspector.
|
JobConstrainerSearchResults |
getJobConstrainersBySearch(JobConstrainerQuery jobConstrainerQuery,
JobConstrainerSearch jobConstrainerSearch)
Gets the search results matching the given search query using the
given search.
|
JobConstrainerSearch |
getJobConstrainerSearch()
Gets a job constrainer search.
|
JobConstrainerSearchOrder |
getJobConstrainerSearchOrder()
Gets a job constrainer search order.
|
canSearchJobConstrainers, getFoundry, getFoundryId, getJobConstrainerQuery, getJobConstrainersByQuery, useFederatedFoundryView, useIsolatedFoundryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
JobConstrainerSearch getJobConstrainerSearch()
mandatory
- This method must be implemented. JobConstrainerSearchOrder getJobConstrainerSearchOrder()
JobConstrainerSearchOrder
is supplied to a
JobConstrainerSearch
to specify the ordering of results.mandatory
- This method must be implemented. JobConstrainerSearchResults getJobConstrainersBySearch(JobConstrainerQuery jobConstrainerQuery, JobConstrainerSearch jobConstrainerSearch) throws OperationFailedException, PermissionDeniedException
jobConstrainerQuery
- the job constrainer queryjobConstrainerSearch
- the job constrainer searchNullArgumentException
- jobConstrainerQuery
or jobConstrainerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- jobConstrainerQuery
or jobConstrainerSearch
is not of this
servicemandatory
- This method must be implemented. JobConstrainerQuery getJobConstrainerQueryFromInspector(JobConstrainerQueryInspector jobConstrainerQueryInspector)
JobConstrainerSearchResults.
jobConstrainerQueryInspector
- a job constrainer query inspectorNullArgumentException
-
jobConstrainerQueryInspector
is null
UnsupportedException
-
jobConstrainerQueryInspector
is not of this servicemandatory
- This method must be implemented.