public interface AuditEnablerSearchSession extends AuditEnablerQuerySession
This session provides methods for searching among AuditEnabler
objects. The search query is constructed using the
AuditEnableryQuery.
getAuditEnablersByQuery()
is the basic search method
and returns a list of AuditEnablers.
A more advanced search
may be performed with getAuditEnablersBySearch().
It
accepts an AuditEnablerSearch
in addition to the query for
the purpose of specifying additional options affecting the entire search,
such as inquiry. getAuditEnablersBySearch()
returns an
AuditEnablerSearchResults
that can be used to access the
resulting AuditEnablerList
or be used to perform a search
within the result set through AuditEnablerSearch.
This session defines views that offer differing behaviors for searching.
AuditEnablers
may have a query record indicated by
their respective record types. The query record is accessed via the
AuditEnablerQuery.
Modifier and Type | Method and Description |
---|---|
AuditEnablerQuery |
getAuditEnablerQueryFromInspector(AuditEnablerQueryInspector auditEnablerQueryInspector)
Gets an audit enabler query from an inspector.
|
AuditEnablerSearchResults |
getAuditEnablersBySearch(AuditEnablerQuery auditEnablerQuery,
AuditEnablerSearch auditEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
AuditEnablerSearch |
getAuditEnablerSearch()
Gets an audit enabler search.
|
AuditEnablerSearchOrder |
getAuditEnablerSearchOrder()
Gets an audit enabler search order.
|
canSearchAuditEnablers, getAuditEnablerQuery, getAuditEnablersByQuery, getInquest, getInquestId, useFederatedInquestView, useIsolatedInquestView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AuditEnablerSearch getAuditEnablerSearch()
mandatory
- This method must be implemented. AuditEnablerSearchOrder getAuditEnablerSearchOrder()
AuditEnablerSearchOrder
is supplied to an AuditEnablerSearch
to specify
the ordering of results.mandatory
- This method must be implemented. AuditEnablerSearchResults getAuditEnablersBySearch(AuditEnablerQuery auditEnablerQuery, AuditEnablerSearch auditEnablerSearch) throws OperationFailedException, PermissionDeniedException
auditEnablerQuery
- the audit enabler queryauditEnablerSearch
- the audit enabler searchNullArgumentException
- auditEnablerQuery
or auditEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auditEnablerQuery
or auditEnablerSearch
is not of this servicemandatory
- This method must be implemented. AuditEnablerQuery getAuditEnablerQueryFromInspector(AuditEnablerQueryInspector auditEnablerQueryInspector)
AuditEnablerSearchResults.
auditEnablerQueryInspector
- an audit enabler query inspectorNullArgumentException
-
auditEnablerQueryInspector
is null
UnsupportedException
-
auditEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.