public interface JobProcessorEnablerSearchSession extends JobProcessorEnablerQuerySession
This session provides methods for searching among
JobProcessorEnabler
objects. The search query is constructed using
the JobProcessorEnableryQuery.
getJobProcessorEnablersByQuery()
is the basic search
method and returns a list of JobProcessorEnablers.
A more
advanced search may be performed with
getJobProcessorEnablersBySearch().
It accepts a
JobProcessorEnablerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
resourcing. getJobProcessorEnablersBySearch()
returns a
JobProcessorEnablerSearchResults
that can be used to access
the resulting JobProcessorEnablerList
or be used to perform
a search within the result set through JobProcessorEnablerSearch.
This session defines views that offer differing behaviors for searching.
JobProcessorEnablers
may have a query record indicated
by their respective record types. The query record is accessed via the
JobProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
JobProcessorEnablerQuery |
getJobProcessorEnablerQueryFromInspector(JobProcessorEnablerQueryInspector jobProcessorEnablerQueryInspector)
Gets a job processor enabler query from an inspector.
|
JobProcessorEnablerSearchResults |
getJobProcessorEnablersBySearch(JobProcessorEnablerQuery jobProcessorEnablerQuery,
JobProcessorEnablerSearch jobProcessorEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
JobProcessorEnablerSearch |
getJobProcessorEnablerSearch()
Gets a job processor enabler search.
|
JobProcessorEnablerSearchOrder |
getJobProcessorEnablerSearchOrder()
Gets a job processor enabler search order.
|
canSearchJobProcessorEnablers, getFoundry, getFoundryId, getJobProcessorEnablerQuery, getJobProcessorEnablersByQuery, useFederatedFoundryView, useIsolatedFoundryView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
JobProcessorEnablerSearch getJobProcessorEnablerSearch()
mandatory
- This method must be implemented. JobProcessorEnablerSearchOrder getJobProcessorEnablerSearchOrder()
JobProcessorEnablerSearchOrder
is supplied to a
JobProcessorEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. JobProcessorEnablerSearchResults getJobProcessorEnablersBySearch(JobProcessorEnablerQuery jobProcessorEnablerQuery, JobProcessorEnablerSearch jobProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
jobProcessorEnablerQuery
- the job processor enabler queryjobProcessorEnablerSearch
- the job processor enabler searchNullArgumentException
- jobProcessorEnablerQuery
or jobProcessorEnablerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- jobProcessorEnablerQuery
or jobProcessorEnablerSearch
is not of
this servicemandatory
- This method must be implemented. JobProcessorEnablerQuery getJobProcessorEnablerQueryFromInspector(JobProcessorEnablerQueryInspector jobProcessorEnablerQueryInspector)
JobProcessorEnablerSearchResults.
jobProcessorEnablerQueryInspector
- a job processor enabler
query inspectorNullArgumentException
-
jobProcessorEnablerQueryInspector
is null
UnsupportedException
-
jobProcessorEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.