Java doc tidy up in auditing and scheduled actions

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5295 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Andrew Hind
2007-03-05 15:51:09 +00:00
parent 5f0401612c
commit 48fe361cf2
16 changed files with 420 additions and 94 deletions

View File

@@ -26,43 +26,57 @@ package org.alfresco.repo.audit;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* The audit model used for application level auditing.
*
* @author andyh
*/
public interface ApplicationAuditModel
{
/**
* Report if audit behaviour can be determined before the method call
*
* @param auditState,
* @param mi
* @return
* @param auditMode
* @param application
* @param description
* @param key
* @param args
* @return - the audit mode
*/
public AuditMode beforeExecution(AuditMode auditMode, String application, String description,
NodeRef key, Object... args);
public AuditMode beforeExecution(AuditMode auditMode, String application, String description, NodeRef key,
Object... args);
/**
* Report if audit behaviour can be determined after the method call
*
* @param auditState,
* @param mi
* @return
* @param auditMode
* @param application
* @param description
* @param key
* @param args
* @return - the audit mode
*/
public AuditMode afterExecution(AuditMode auditMode, String application, String description,
NodeRef key, Object... args);
public AuditMode afterExecution(AuditMode auditMode, String application, String description, NodeRef key,
Object... args);
/**
* Report if audit behaviour should be invoked on error. It could be we look at the error and filter - this is not supported at the moment.
* Report if audit behaviour should be invoked on error. It could be we look at the error and filter - this is not
* supported at the moment.
*
* @param auditState,
* @param mi
* @return
* @param auditMode
* @param application
* @param description
* @param key
* @param args
* @return - the audit mode
*/
public AuditMode onError(AuditMode auditMode, String application, String description,
NodeRef key, Object... args);
public AuditMode onError(AuditMode auditMode, String application, String description, NodeRef key, Object... args);
/**
* Get the optional parameters that are to be recorded
*
* @param mi
* @return
*/
/**
* Get the optional parameters that are to be recorded
*
* @param application
* @return - the audit mode
*/
public RecordOptions getAuditRecordOptions(String application);
}