com.atlassian.jira.auditing
Interface AuditingService

All Known Implementing Classes:

DefaultAuditingService

@ExperimentalApi
public interface AuditingService

Service for managing auditing records

Since:

v6.3

Method Summary

ServiceOutcome<Records>	getRecords(ApplicationUser user, Integer offset, Integer maxResults, AuditingFilter filter)
Long	getTotalNumberOfRecords() Returns total number of audit records
ErrorCollection	storeRecord(ApplicationUser user, String category, String summary, AssociatedItem objectItem, Iterable<ChangedValue> values, Iterable<AssociatedItem> associatedItems) Store record in Auditing

Method Detail

getRecords

@Nonnull
ServiceOutcome<Records> getRecords(@Nonnull
                                           ApplicationUser user,
                                           @Nullable
                                           Integer offset,
                                           @Nullable
                                           Integer maxResults,
                                           @Nullable
                                           AuditingFilter filter)

Parameters:

user - authenticated user that has permission to get records

offset - the offset from which search starts

maxResults - maximum number of returned results

filter - defines how records should be filtered out before being returned, if null records will not be filtered

Returns:

Records instance wrapped in ServiceOutcome

storeRecord

@Nonnull
ErrorCollection storeRecord(@Nullable
                                    ApplicationUser user,
                                    @Nullable
                                    String category,
                                    @Nullable
                                    String summary,
                                    @Nullable
                                    AssociatedItem objectItem,
                                    @Nullable
                                    Iterable<ChangedValue> values,
                                    @Nullable
                                    Iterable<AssociatedItem> associatedItems)

Store record in Auditing

Parameters:

associatedItems - @return

getTotalNumberOfRecords

@Nonnull
Long getTotalNumberOfRecords()

Returns total number of audit records

Returns:

total number of records