public interface AuditSearchSession extends AuditQuerySession
This session provides methods for searching among Audit
objects. The search query is constructed using the AudityQuery.
getAuditsByQuery()
is the basic search method and
returns a list of Audits.
A more advanced search may be
performed with getAuditsBySearch().
It accepts an
AuditSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getAuditsBySearch()
returns an AuditSearchResults
that can be used to access the resulting AuditList
or be
used to perform a search within the result set through AuditSearch.
This session defines views that offer differing behaviors for searching.
Audits may have an audit record indicated by their respective record
types. The audit record is accessed via the AuditQuery.
Modifier and Type | Method and Description |
---|---|
AuditQuery |
getAuditQueryFromInspector(AuditQueryInspector auditQueryInspector)
Gets an audit query from an inspector.
|
AuditSearchResults |
getAuditsBySearch(AuditQuery auditQuery,
AuditSearch auditSearch)
Gets the search results matching the given search query using the
given search.
|
AuditSearch |
getAuditSearch()
Gets an audit search.
|
AuditSearchOrder |
getAuditSearchOrder()
Gets an audit search order.
|
canSearchAudits, getAuditQuery, getAuditsByQuery, getInquest, getInquestId, useFederatedInquestView, useIsolatedInquestView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AuditSearch getAuditSearch()
mandatory
- This method must be implemented. AuditSearchOrder getAuditSearchOrder()
AuditSearchOrder
is
supplied to an AuditSearch
to specify the ordering of
results.mandatory
- This method must be implemented. AuditSearchResults getAuditsBySearch(AuditQuery auditQuery, AuditSearch auditSearch) throws OperationFailedException, PermissionDeniedException
auditQuery
- the audit queryauditSearch
- the audit searchNullArgumentException
- auditQuery
or
auditSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auditQuery
or
auditSearch
is not of this servicemandatory
- This method must be implemented. AuditQuery getAuditQueryFromInspector(AuditQueryInspector auditQueryInspector)
AuditSearchResults.
auditQueryInspector
- an audit query inspectorNullArgumentException
- auditQueryInspector
is null
UnsupportedException
- auditQueryInspector
is not of this servicemandatory
- This method must be implemented.