public interface StepConstrainerSearchSession extends StepConstrainerQuerySession
This session provides methods for searching among
StepConstrainer
objects. The search query is constructed using the
StepConstraineryQuery.
getStepConstrainersByQuery()
is the basic search method
and returns a list of StepConstrainers.
A more advanced
search may be performed with getStepConstrainersBySearch().
It accepts a StepConstrainerSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as workflow. getStepConstrainersBySearch()
returns a StepConstrainerSearchResults
that can be used to
access the resulting StepConstrainerList
or be used to
perform a search within the result set through
StepConstrainerSearch.
This session defines views that offer differing behaviors for searching.
StepConstrainers
may have a query record indicated by
their respective record types. The query record is accessed via the
StepConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
StepConstrainerQuery |
getStepConstrainerQueryFromInspector(StepConstrainerQueryInspector stepConstrainerQueryInspector)
Gets a step constrainer query from an inspector.
|
StepConstrainerSearchResults |
getStepConstrainersBySearch(StepConstrainerQuery stepConstrainerQuery,
StepConstrainerSearch stepConstrainerSearch)
Gets the search results matching the given search query using the
given search.
|
StepConstrainerSearch |
getStepConstrainerSearch()
Gets a step constrainer search.
|
StepConstrainerSearchOrder |
getStepConstrainerSearchOrder()
Gets a step constrainer search order.
|
canSearchStepConstrainers, getOffice, getOfficeId, getStepConstrainerQuery, getStepConstrainersByQuery, useFederatedOfficeView, useIsolatedOfficeView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
StepConstrainerSearch getStepConstrainerSearch()
mandatory
- This method must be implemented. StepConstrainerSearchOrder getStepConstrainerSearchOrder()
StepConstrainerSearchOrder
is supplied to a
StepConstrainerSearch
to specify the ordering of results.mandatory
- This method must be implemented. StepConstrainerSearchResults getStepConstrainersBySearch(StepConstrainerQuery stepConstrainerQuery, StepConstrainerSearch stepConstrainerSearch) throws OperationFailedException, PermissionDeniedException
stepConstrainerQuery
- the step constrainer querystepConstrainerSearch
- the step constrainer searchNullArgumentException
- stepConstrainerQuery
or stepConstrainerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stepConstrainerQuery
or stepConstrainerSearch
is not of this
servicemandatory
- This method must be implemented. StepConstrainerQuery getStepConstrainerQueryFromInspector(StepConstrainerQueryInspector stepConstrainerQueryInspector)
StepConstrainerSearchResults.
stepConstrainerQueryInspector
- a step constrainer query
inspectorNullArgumentException
-
stepConstrainerQueryInspector
is null
UnsupportedException
-
stepConstrainerQueryInspector
is not of this servicemandatory
- This method must be implemented.