public interface AuditService
View Audit History
privilege.Modifier and Type | Method and Description |
---|---|
void |
clearSearchResults()
Releases any cached information about the query that is associated with the current search.
|
Set<AuditAction> |
getAuditActions()
Gets a comprehensive set of audit actions that can appear in the audit trail.
|
List<AuditEntryDetail> |
getDetails(String id)
Gets the audit details for a single audit entry with the identifier.
|
int |
getSearchPageSizeLimit()
Gets the maximum number of audit entries that can be returned in a single request.
|
List<AuditEntry> |
getSearchResults(int fromRow,
int toRow)
Gets a range of results after calling
search(AuditQuery) . |
SearchResultsInfo |
search(AuditQuery query)
Searches the global audit history and returns the information that describes the results, not the results themselves.
|
SearchResultsInfo search(AuditQuery query)
getSearchResults(int, int)
. When the results are no longer required, call clearSearchResults()
to release any server-side resources that are related to the query.
Note: Only one query can be active at a time for a client. The results that are generated for the query can be used to
iterate through the results by calling getSearchResults(int, int)
, but if a client calls this
method again, a new set of results is generated, and the previous results are no longer valid.
query
- the search criteria with which to query the audit history.List<AuditEntry> getSearchResults(int fromRow, int toRow) throws AuditSearchException
search(AuditQuery)
. The from row
and to row
values should be between 1 and the total rows that are retrieved by the query. This is considered a page
of
results, and therefore, a pageable
results model.
Note: The maximum number of records that can be returned
for a single page is determined by getSearchPageSizeLimit()
. The default maximum is 5000.
fromRow
- the starting row number to include in the results. Must be greater than 0.toRow
- the ending row number to include in the results. Must be less than or equal to the total row count.
The total number retrieved must be less than or equal to the page size limit.AuditSearchException
- thrown when the results have been cleared from the server or when the total row number
requested exceeds the page size limit.List<AuditEntryDetail> getDetails(String id)
id
- the unique identifier of the audit entry.void clearSearchResults()
search(AuditQuery)
. If the results no longer exist when this method is
called, then this method returns without further action.int getSearchPageSizeLimit()
Set<AuditAction> getAuditActions()
search(AuditQuery)
.<i>Copyright (c) 2021, SAS Institute Inc., Cary, NC, USA</i>