public interface JobConstrainerEnablerSearchSession extends JobConstrainerEnablerQuerySession
This session provides methods for searching among
JobConstrainerEnabler
objects. The search query is constructed
using the JobConstrainerEnableryQuery.
getJobConstrainerEnablersByQuery()
is the basic search
method and returns a list of JobConstrainerEnablers.
A more
advanced search may be performed with
getJobConstrainerEnablersBySearch().
It accepts a
JobConstrainerEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as resourcing. getJobConstrainerEnablersBySearch()
returns
a JobConstrainerEnablerSearchResults
that can be used to
access the resulting JobConstrainerEnablerList
or be used
to perform a search within the result set through
JobConstrainerEnablerSearch.
This session defines views that offer differing behaviors for searching.
JobConstrainerEnablers
may have a job constrainer
enabler query record indicated by their respective record types. The job
constrainer enabler query record is accessed via the
JobConstrainerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
JobConstrainerEnablerQuery |
getJobConstrainerEnablerQueryFromInspector(JobConstrainerEnablerQueryInspector jobConstrainerEnablerQueryInspector)
Gets a job constrainer enabler query from an inspector.
|
JobConstrainerEnablerSearchResults |
getJobConstrainerEnablersBySearch(JobConstrainerEnablerQuery jobConstrainerEnablerQuery,
JobConstrainerEnablerSearch jobConstrainerEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
JobConstrainerEnablerSearch |
getJobConstrainerEnablerSearch()
Gets a job constrainer enabler search.
|
JobConstrainerEnablerSearchOrder |
getJobConstrainerEnablerSearchOrder()
Gets a job constrainer enabler search order.
|
canSearchJobConstrainerEnablers, getFoundry, getFoundryId, getJobConstrainerEnablerQuery, getJobConstrainerEnablersByQuery, useFederatedFoundryView, useIsolatedFoundryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
JobConstrainerEnablerSearch getJobConstrainerEnablerSearch()
mandatory
- This method must be implemented. JobConstrainerEnablerSearchOrder getJobConstrainerEnablerSearchOrder()
JobConstrainerEnablerSearchOrder
is supplied to a
JobConstrainerEnablerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. JobConstrainerEnablerSearchResults getJobConstrainerEnablersBySearch(JobConstrainerEnablerQuery jobConstrainerEnablerQuery, JobConstrainerEnablerSearch jobConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
jobConstrainerEnablerQuery
- the job constrainer enabler queryjobConstrainerEnablerSearch
- the job constrainer enabler searchNullArgumentException
-
jobConstrainerEnablerQuery
or
jobConstrainerEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
jobConstrainerEnablerQuery
or
jobConstrainerEnablerSearch
is not of this servicemandatory
- This method must be implemented. JobConstrainerEnablerQuery getJobConstrainerEnablerQueryFromInspector(JobConstrainerEnablerQueryInspector jobConstrainerEnablerQueryInspector)
JobConstrainerEnablerSearchResults.
jobConstrainerEnablerQueryInspector
- a job constrainer enabler
query inspectorNullArgumentException
-
jobConstrainerEnablerQueryInspector
is null
UnsupportedException
-
jobConstrainerEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.