public interface ProcessSearchSession extends ProcessQuerySession
This session provides methods for searching among Process
objects. The search query is constructed using the
ProcessQuery.
getProcesssByQuery()
is the basic search method and
returns a list of Processes.
A more advanced search may be
performed with getProcessesBySearch().
It accepts a
ProcessSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getProcessesBySearch()
returns a
ProcessSearchResults
that can be used to access the resulting
ProcessList
or be used to perform a search within the
result set through ProcessSearch.
This session defines views that offer differing behaviors for searching.
Processes may have a query record indicated by their respective record
types. The query record is accessed via the ProcessQuery.
Modifier and Type | Method and Description |
---|---|
ProcessSearchResults |
getProcessesBySearch(ProcessQuery processQuery,
ProcessSearch processSearch)
Gets the search results matching the given search query using the
given search.
|
ProcessQuery |
getProcessQueryFromInspector(ProcessQueryInspector processQueryInspector)
Gets a process query from an inspector.
|
ProcessSearch |
getProcessSearch()
Gets a process search.
|
ProcessSearchOrder |
getProcessSearchOrder()
Gets a process search order.
|
canSearchProcesses, getOffice, getOfficeId, getProcessesByQuery, getProcessQuery, useFederatedOfficeView, useIsolatedOfficeView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProcessSearch getProcessSearch()
mandatory
- This method must be implemented. ProcessSearchOrder getProcessSearchOrder()
ProcessSearchOrder
is
supplied to a ProcessSearch
to specify the ordering of
results.mandatory
- This method must be implemented. ProcessSearchResults getProcessesBySearch(ProcessQuery processQuery, ProcessSearch processSearch) throws OperationFailedException, PermissionDeniedException
processQuery
- the process queryprocessSearch
- the process searchNullArgumentException
- processQuery
or
processSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- processQuery
or
processSearch
is not of this servicemandatory
- This method must be implemented. ProcessQuery getProcessQueryFromInspector(ProcessQueryInspector processQueryInspector)
ProcessSearchResults.
processQueryInspector
- a process query inspectorNullArgumentException
- processQueryInspector
is null
UnsupportedException
- processQueryInspector
is not of this servicemandatory
- This method must be implemented.