public interface StepSearchSession extends StepQuerySession
This session provides methods for searching among Step
objects. The search query is constructed using the StepQuery.
getStepsByQuery()
is the basic search method and
returns a list of Steps.
A more advanced search may be
performed with getStepsBySearch().
It accepts a
StepSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getStepsBySearch()
returns a StepSearchResults
that
can be used to access the resulting StepList
or be used to
perform a search within the result set through StepSearch.
This session defines views that offer differing behaviors for searching.
Steps may have a query record indicated by their respective record
types. The query record is accessed via the StepQuery.
Modifier and Type | Method and Description |
---|---|
StepQuery |
getStepQueryFromInspector(StepQueryInspector stepQueryInspector)
Gets a step query from an inspector.
|
StepSearchResults |
getStepsBySearch(StepQuery stepQuery,
StepSearch stepSearch)
Gets the search results matching the given search query using the
given search.
|
StepSearch |
getStepSearch()
Gets a step search.
|
StepSearchOrder |
getStepSearchOrder()
Gets a step search order.
|
canSearchSteps, getOffice, getOfficeId, getStepQuery, getStepsByQuery, useFederatedOfficeView, useIsolatedOfficeView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
StepSearch getStepSearch()
mandatory
- This method must be implemented. StepSearchOrder getStepSearchOrder()
StepSearchOrder
is
supplied to a StepSearch
to specify the ordering of
results.mandatory
- This method must be implemented. StepSearchResults getStepsBySearch(StepQuery stepQuery, StepSearch stepSearch) throws OperationFailedException, PermissionDeniedException
stepQuery
- the step querystepSearch
- the step searchNullArgumentException
- stepQuery
or
stepSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stepQuery
or
stepSearch
is not of this servicemandatory
- This method must be implemented. StepQuery getStepQueryFromInspector(StepQueryInspector stepQueryInspector)
StepSearchResults.
stepQueryInspector
- a step query inspectorNullArgumentException
- stepQueryInspector
is null
UnsupportedException
- stepQueryInspector
is not of this servicemandatory
- This method must be implemented.