|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ExperimentalApi public interface AuditingService
Service for managing auditing records
Method Summary | |
---|---|
ServiceOutcome<Records> |
getRecords(Integer offset,
Integer maxResults,
AuditingFilter filter)
|
Long |
getTotalNumberOfRecords()
Returns total number of audit records |
ErrorCollection |
storeRecord(String category,
String summary,
AssociatedItem objectItem,
Iterable<ChangedValue> values,
Iterable<AssociatedItem> associatedItems)
Store record in Auditing Log |
ErrorCollection |
storeRecord(String category,
String summary,
String eventSourceKey,
AssociatedItem objectItem,
Iterable<ChangedValue> values,
Iterable<AssociatedItem> associatedItems)
/** Store record in Auditing Log along with plugin name created the event |
Method Detail |
---|
@Nonnull ServiceOutcome<Records> getRecords(@Nullable Integer offset, @Nullable Integer maxResults, @Nullable AuditingFilter filter)
offset
- the offset from which search startsmaxResults
- maximum number of returned resultsfilter
- defines how records should be filtered out before being returned, if null records will not be filtered
@Nonnull ErrorCollection storeRecord(@Nullable String category, @Nullable String summary, @Nullable AssociatedItem objectItem, @Nullable Iterable<ChangedValue> values, @Nullable Iterable<AssociatedItem> associatedItems)
category
- - category of the log recordsummary
- - description of the changeobjectItem
- - changed objectvalues
- - changed values of the object itemassociatedItems
- - other objects that were affected by this changeassociatedItems
- @return@Nonnull ErrorCollection storeRecord(@Nonnull String category, @Nonnull String summary, @Nonnull String eventSourceKey, @Nullable AssociatedItem objectItem, @Nullable Iterable<ChangedValue> values, @Nullable Iterable<AssociatedItem> associatedItems)
category
- - category of the log recordsummary
- - description of the changeeventSourceKey
- - key of plugin which creates the recordobjectItem
- - changed objectvalues
- - changed values of the object itemassociatedItems
- - other objects that were affected by this changeassociatedItems
- @return@Nonnull Long getTotalNumberOfRecords()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |