com.atlassian.jira.auditing
Interface AuditingManager

All Known Implementing Classes:
AuditingManagerImpl

public interface AuditingManager

Since:
v6.2

Method Summary
 long countRecords(Long maxId, Long sinceId)
           
 long countRecordsWithoutSysAdmin(Long maxId, Long sinceId)
           
 Records getRecords(Long maxId, Long sinceId, Long count, Long page)
          Get records from the database.
 Records getRecordsWithoutSysAdmin(Long maxId, Long sinceId, Long count, Long page)
          Does the same as #getRecords(Long, Long, Long) but filters out all records authored by sysadmins (users who were sysadmins at the time of performing the action)
 boolean isAuditingEnabled()
           
 void setAuditingEnabled(boolean enable)
          Set the state of Auditing (enabled/disabled).
 void store(RecordRequest request)
           
 

Method Detail

store

void store(RecordRequest request)

getRecords

@Nonnull
Records getRecords(@Nullable
                           Long maxId,
                           @Nullable
                           Long sinceId,
                           @Nullable
                           Long count,
                           @Nullable
                           Long page)
Get records from the database.

Parameters:
maxId - max record id to return (including), doesn't have to represent a real record in the database
sinceId - smallest record id to return (including), doesn't have to represent a real record in the database
count - number of records to get, you cannot get more than 1000 records at once (if you provide larger number it will be automatically capped)
page - which page should be returned (if null first page will be returned; numeration of pages starts from 1)
Returns:

countRecords

long countRecords(@Nullable
                  Long maxId,
                  @Nullable
                  Long sinceId)

getRecordsWithoutSysAdmin

@Nonnull
Records getRecordsWithoutSysAdmin(@Nullable
                                          Long maxId,
                                          @Nullable
                                          Long sinceId,
                                          @Nullable
                                          Long count,
                                          @Nullable
                                          Long page)
Does the same as #getRecords(Long, Long, Long) but filters out all records authored by sysadmins (users who were sysadmins at the time of performing the action)


countRecordsWithoutSysAdmin

long countRecordsWithoutSysAdmin(@Nullable
                                 Long maxId,
                                 @Nullable
                                 Long sinceId)

isAuditingEnabled

boolean isAuditingEnabled()

setAuditingEnabled

void setAuditingEnabled(boolean enable)
                        throws PermissionException
Set the state of Auditing (enabled/disabled).

Parameters:
enable - if true then enable auditing
Throws:
PermissionException - If the currently logged in user is not a system administrator


Copyright © 2002-2014 Atlassian. All Rights Reserved.