public interface StepProcessorSearchSession extends StepProcessorQuerySession
This session provides methods for searching among StepProcessor
objects. The search query is constructed using the
StepProcessoryQuery.
getStepProcessorsByQuery()
is the basic search method
and returns a list of StepProcessors.
A more advanced
search may be performed with getStepProcessorsBySearch().
It accepts a StepProcessorSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as workflow. getStepProcessorsBySearch()
returns a StepProcessorSearchResults
that can be used to
access the resulting StepProcessorList
or be used to
perform a search within the result set through StepProcessorSearch.
This session defines views that offer differing behaviors for searching.
StepProcessors
may have a query record indicated by
their respective record types. Thequery record is accessed via the
StepProcessorQuery.
Modifier and Type | Method and Description |
---|---|
StepProcessorQuery |
getStepProcessorQueryFromInspector(StepProcessorQueryInspector stepProcessorQueryInspector)
Gets a step processor query from an inspector.
|
StepProcessorSearchResults |
getStepProcessorsBySearch(StepProcessorQuery stepProcessorQuery,
StepProcessorSearch stepProcessorSearch)
Gets the search results matching the given search query using the
given search.
|
StepProcessorSearch |
getStepProcessorSearch()
Gets a step processor search.
|
StepProcessorSearchOrder |
getStepProcessorSearchOrder()
Gets a step processor search order.
|
canSearchStepProcessors, getOffice, getOfficeId, getStepProcessorQuery, getStepProcessorsByQuery, useFederatedOfficeView, useIsolatedOfficeView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
StepProcessorSearch getStepProcessorSearch()
mandatory
- This method must be implemented. StepProcessorSearchOrder getStepProcessorSearchOrder()
StepProcessorSearchOrder
is supplied to a
StepProcessorSearch
to specify the ordering of results.mandatory
- This method must be implemented. StepProcessorSearchResults getStepProcessorsBySearch(StepProcessorQuery stepProcessorQuery, StepProcessorSearch stepProcessorSearch) throws OperationFailedException, PermissionDeniedException
stepProcessorQuery
- the step processor querystepProcessorSearch
- the step processor searchNullArgumentException
- stepProcessorQuery
or stepProcessorSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stepProcessorQuery
or stepProcessorSearch
is not of this
servicemandatory
- This method must be implemented. StepProcessorQuery getStepProcessorQueryFromInspector(StepProcessorQueryInspector stepProcessorQueryInspector)
StepProcessorSearchResults.
stepProcessorQueryInspector
- a step processor query inspectorNullArgumentException
-
stepProcessorQueryInspector
is null
UnsupportedException
-
stepProcessorQueryInspector
is not of this servicemandatory
- This method must be implemented.