public interface TriggerEnablerSearchSession extends TriggerEnablerQuerySession
This session provides methods for searching among TriggerEnabler
objects. The search query is constructed using the
TriggerEnableryQuery.
getTriggerEnablersByQuery()
is the basic search method
and returns a list of TriggerEnablers.
A more advanced
search may be performed with getTriggerEnablersBySearch().
It accepts a TriggerEnablerSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as offering. getTriggerEnablersBySearch()
returns a TriggerEnablerSearchResults
that can be used to
access the resulting TriggerEnablerList
or be used to
perform a search within the result set through
TriggerEnablerSearch.
This session defines views that offer differing behaviors for searching.
TriggerEnablers
may have a query record indicated by
their respective record types. The query record is accessed via the
TriggerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
TriggerEnablerQuery |
getTriggerEnablerQueryFromInspector(TriggerEnablerQueryInspector triggerEnablerQueryInspector)
Gets a trigger enabler query from an inspector.
|
TriggerEnablerSearchResults |
getTriggerEnablersBySearch(TriggerEnablerQuery triggerEnablerQuery,
TriggerEnablerSearch triggerEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
TriggerEnablerSearch |
getTriggerEnablerSearch()
Gets a trigger enabler search.
|
TriggerEnablerSearchOrder |
getTriggerEnablerSearchOrder()
Gets a trigger enabler search order.
|
canSearchTriggerEnablers, getSystem, getSystemId, getTriggerEnablerQuery, getTriggerEnablersByQuery, useFederatedSystemView, useIsolatedSystemView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
TriggerEnablerSearch getTriggerEnablerSearch()
mandatory
- This method must be implemented. TriggerEnablerSearchOrder getTriggerEnablerSearchOrder()
TriggerEnablerSearchOrder
is supplied to a
TriggerEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. TriggerEnablerSearchResults getTriggerEnablersBySearch(TriggerEnablerQuery triggerEnablerQuery, TriggerEnablerSearch triggerEnablerSearch) throws OperationFailedException, PermissionDeniedException
triggerEnablerQuery
- the trigger enabler querytriggerEnablerSearch
- the trigger enabler searchNullArgumentException
- triggerEnablerQuery
or triggerEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- triggerEnablerQuery
or triggerEnablerSearch
is not of this
servicemandatory
- This method must be implemented. TriggerEnablerQuery getTriggerEnablerQueryFromInspector(TriggerEnablerQueryInspector triggerEnablerQueryInspector)
TriggerEnablerSearchResults.
triggerEnablerQueryInspector
- a trigger enabler query inspectorNullArgumentException
-
triggerEnablerQueryInspector
is null
UnsupportedException
-
triggerEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.