public interface ProcessEnablerSearchSession extends ProcessEnablerQuerySession
This session provides methods for searching among ProcessEnabler
objects. The search query is constructed using the
ProcessEnableryQuery.
getProcessEnablersByQuery()
is the basic search method
and returns a list of ProcessEnablers.
A more advanced
search may be performed with getProcessEnablersBySearch().
It accepts a ProcessEnablerSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as workflow. getProcessEnablersBySearch()
returns a ProcessEnablerSearchResults
that can be used to
access the resulting ProcessEnablerList
or be used to
perform a search within the result set through
ProcessEnablerSearch.
This session defines views that offer differing behaviors for searching.
ProcessEnablers
may have a query record indicated by
their respective record types. The query record is accessed via the
ProcessEnablerQuery.
Modifier and Type | Method and Description |
---|---|
ProcessEnablerQuery |
getProcessEnablerQueryFromInspector(ProcessEnablerQueryInspector processEnablerQueryInspector)
Gets a process enabler query from an inspector.
|
ProcessEnablerSearchResults |
getProcessEnablersBySearch(ProcessEnablerQuery processEnablerQuery,
ProcessEnablerSearch processEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
ProcessEnablerSearch |
getProcessEnablerSearch()
Gets a process enabler search.
|
ProcessEnablerSearchOrder |
getProcessEnablerSearchOrder()
Gets a process enabler search order.
|
canSearchProcessEnablers, getOffice, getOfficeId, getProcessEnablerQuery, getProcessEnablersByQuery, useFederatedOfficeView, useIsolatedOfficeView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProcessEnablerSearch getProcessEnablerSearch()
mandatory
- This method must be implemented. ProcessEnablerSearchOrder getProcessEnablerSearchOrder()
ProcessEnablerSearchOrder
is supplied to a
ProcessEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. ProcessEnablerSearchResults getProcessEnablersBySearch(ProcessEnablerQuery processEnablerQuery, ProcessEnablerSearch processEnablerSearch) throws OperationFailedException, PermissionDeniedException
processEnablerQuery
- the process enabler queryprocessEnablerSearch
- the process enabler searchNullArgumentException
- processEnablerQuery
or processEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- processEnablerQuery
or processEnablerSearch
is not of this
servicemandatory
- This method must be implemented. ProcessEnablerQuery getProcessEnablerQueryFromInspector(ProcessEnablerQueryInspector processEnablerQueryInspector)
ProcessEnablerSearchResults.
processEnablerQueryInspector
- a process enabler query inspectorNullArgumentException
-
processEnablerQueryInspector
is null
UnsupportedException
-
processEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.