Package com.aquima.interactions.foundation.logging.audit

Interface IAuditMessage

All Superinterfaces:
Serializable
All Known Implementing Classes:
AuditMessage, DocumentAuditMessage, MailAuditMessage, TaskExecutionAuditMessage, WebServiceAuditMessage
public interface IAuditMessage extends Serializable
This interface describes an audit message. Audit messages are used to register an audit trail through the application. The audit trail should describe what a user has done within the application's lifetime.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCaseId()
    Returns the id of the case in which the audit message occurs, when the message was not created in a case context the case id can be null.
    Map<String,String>
    getContext()
    Returns context for this audit message, e.g.
    String
    getEventType()
    Returns the event type for which the audit message was registered, e.g.
    String
    getSourceId()
    Returns the source id which can be used to identify the source with, e.g.
    String
    getSourceType()
    Returns the source type for which the audit message was registered, e.g.
    Long
    getTaskId()
    Returns the id of the task in which the audit message occurs, when the message was not created in a case context the task id can be null.
    String
    getTaskName()
    Returns the task name in which the audit message occurs, when the message was not created in a task context the task name can be null.

  • Method Details

    • getEventType

      String getEventType()
      Returns the event type for which the audit message was registered, e.g. Create, Read, Update, Delete, Search. The implementer of this interface can define their own event types or use existing ones already defined on: AuditMessage.EventType
      Returns:
      The event type, cannot be null.

    • getCaseId

      String getCaseId()
      Returns the id of the case in which the audit message occurs, when the message was not created in a case context the case id can be null. The implementer of this interface is supposed to get the case id from the profile and set it on their implementation of this interface.
      Returns:
      The case id, can be null.

    • getTaskName

      String getTaskName()
      Returns the task name in which the audit message occurs, when the message was not created in a task context the task name can be null. The implementer of this interface is supposed to get the task name from the profile and set it on their implementation of this interface.
      Returns:
      The task name, can be null.

    • getTaskId

      Long getTaskId()
      Returns the id of the task in which the audit message occurs, when the message was not created in a case context the task id can be null. The implementer of this interface is supposed to get the task id from the profile and set it on their implementation of this interface.
      Returns:
      The task id, can be null.

    • getSourceType

      String getSourceType()
      Returns the source type for which the audit message was registered, e.g. Rest_Service_Call, DCM_TaskList. The source type can be anything the implementer wishes to be.
      Returns:
      The source type, cannot be null.

    • getSourceId

      String getSourceId()
      Returns the source id which can be used to identify the source with, e.g. name of the used webservice.
      Returns:
      The source id, cannot be null.

    • getContext

      Map<String,String> getContext()
      Returns context for this audit message, e.g. properties, parameters, response code, web service URL, aggregate version, etc. Any arbitrary string key on string value can be set here as extra context data.
      Returns:
      The context, can be null.