org.alfresco.service.cmr.audit
Interface AuditService.AuditQueryCallback

All Known Implementing Classes:
AuditDAOTest.AuditQueryCallbackImpl
Enclosing interface:
AuditService

public static interface AuditService.AuditQueryCallback

The interface that will be used to give query results to the calling code.

Since:
3.2

Method Summary
 boolean handleAuditEntry(java.lang.Long entryId, java.lang.String applicationName, java.lang.String user, long time, java.util.Map values)
          Handle a row of audit entry data.
 boolean handleAuditEntryError(java.lang.Long entryId, java.lang.String errorMsg, java.lang.Throwable error)
          Handle audit entry failures
 boolean valuesRequired()
          Determines whether this callback requires the values argument to be populated when AuditService.AuditQueryCallback.handleAuditEntry(java.lang.Long, java.lang.String, java.lang.String, long, java.util.Map) is called.
 

Method Detail

valuesRequired

boolean valuesRequired()
Determines whether this callback requires the values argument to be populated when AuditService.AuditQueryCallback.handleAuditEntry(java.lang.Long, java.lang.String, java.lang.String, long, java.util.Map) is called.

Returns:
true if this callback requires the values argument to be populated

handleAuditEntry

boolean handleAuditEntry(java.lang.Long entryId,
                         java.lang.String applicationName,
                         java.lang.String user,
                         long time,
                         java.util.Map values)
Handle a row of audit entry data.

Parameters:
entryId - the unique audit entry ID
applicationName - the name of the application
user - the user that logged the entry
time - the time of the entry
values - the values map as created
Returns:
Return true to continue processing rows or false to stop

handleAuditEntryError

boolean handleAuditEntryError(java.lang.Long entryId,
                              java.lang.String errorMsg,
                              java.lang.Throwable error)
Handle audit entry failures

Parameters:
entryId - the entry ID
errorMsg - the error message
error - the exception causing the error (may be null)
Returns:
Return true to continue processing rows or false to stop


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.