public interface ActionGroupSearchSession extends ActionGroupQuerySession
This session provides methods for searching among ActionGroup
objects. The search query is constructed using the
ActionGroupQuery.
getActionGroupsByQuery()
is the basic search method and
returns a list of ActionGroups.
A more advanced search may
be performed with getActionGroupsBySearch().
It accepts an
ActionGroupSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getActionGroupsBySearch()
returns an
ActionGroupSearchResults
that can be used to access the resulting
ActionGroupList
or be used to perform a search within the
result set through ActionGroupSearch.
This session defines views that offer differing behaviors for searching.
ActionGroups may have a query record indicated by their respective
record types. The query record is accessed via the
ActionGroupQuery.
Modifier and Type | Method and Description |
---|---|
ActionGroupQuery |
getActionGroupQueryFromInspector(ActionGroupQueryInspector actuionGroupQueryInspector)
Gets an action group query from an inspector.
|
ActionGroupSearchResults |
getActionGroupsBySearch(ActionGroupQuery actuionGroupQuery,
ActionGroupSearch actionGroupSearch)
Gets the search results matching the given search query using the
given search.
|
ActionGroupSearch |
getActionGroupSearch()
Gets an action group search.
|
ActionGroupSearchOrder |
getActionGroupSearchOrder()
Gets an action group search order.
|
canSearchActionGroups, getActionGroupQuery, getActionGroupsByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ActionGroupSearch getActionGroupSearch()
mandatory
- This method must be implemented. ActionGroupSearchOrder getActionGroupSearchOrder()
ActionGroupSearchOrder
is supplied to an ActionGroupSearch
to specify
the ordering of results.mandatory
- This method must be implemented. ActionGroupSearchResults getActionGroupsBySearch(ActionGroupQuery actuionGroupQuery, ActionGroupSearch actionGroupSearch) throws OperationFailedException, PermissionDeniedException
actuionGroupQuery
- the action group queryactionGroupSearch
- the action group searchNullArgumentException
- actuionGroupQuery
or actionGroupSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- actuionGroupQuery
or actionGroupSearch
is not of this servicemandatory
- This method must be implemented. ActionGroupQuery getActionGroupQueryFromInspector(ActionGroupQueryInspector actuionGroupQueryInspector)
ActionGroupSearchResults.
actuionGroupQueryInspector
- an action group query inspectorNullArgumentException
-
actuionGroupQueryInspector
is null
UnsupportedException
-
actuionGroupQueryInspector
is not of this servicemandatory
- This method must be implemented.