Package com.flowable.audit.api.runtime

Interface AuditInstance

All Known Subinterfaces:
AuditInstanceEntity
All Known Implementing Classes:
AuditInstanceEntityImpl
public interface AuditInstance
The runtime instance of an audit entry, typically created through the AuditService.
Author:
Micha Kiener

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAuditDefinitionId()
    Reference to the audit definition of this audit instance.
    Date
    getCreationTime()
    Returns the creation timestamp of this audit instance.
    String
    getCreatorId()
    Returns the id of the user creating this audit instance.
    String
    getExternalId()
    If this audit instance was created from an external system, this optional external id might be used to map to that external data object id, if necessary.
    String
    getId()
    The unique, technical id of this audit instance object.
    Map<String,Object>
    getPayload()
    Returns the optional payload as a byte array for this audit instance as described within the AuditDefinition.
    String
    getScopeDefinitionId()
    Reference to the scope instance definition for which the audit instance was created (if available, might be null).
    String
    getScopeId()
    Reference to the optional scope instance for which the audit instance was created, if any, as this is optional, it might be null.
    String
    getScopeType()
    Type of the optional scope instance for which the audit instance was created (only, if getScopeId() is set).
    String
    getSubScopeId()
    Reference to the optional sub scope instance for which the audit instance was created, if any, as this is optional, it might be null.
    String
    getSubType()
    Returns the sub type of this audit instance.
    String
    getTenantId()
    Returns the id of the tenant this audit instance object belongs to.
    String
    getType()
    Returns the main type of this audit instance.

  • Method Details

    • getTenantId

      String getTenantId()
      Returns the id of the tenant this audit instance object belongs to.

    • getId

      String getId()
      The unique, technical id of this audit instance object.

    • getAuditDefinitionId

      String getAuditDefinitionId()
      Reference to the audit definition of this audit instance.

    • getScopeId

      String getScopeId()
      Reference to the optional scope instance for which the audit instance was created, if any, as this is optional, it might be null.

    • getSubScopeId

      String getSubScopeId()
      Reference to the optional sub scope instance for which the audit instance was created, if any, as this is optional, it might be null.

    • getScopeType

      String getScopeType()
      Type of the optional scope instance for which the audit instance was created (only, if getScopeId() is set).

    • getScopeDefinitionId

      String getScopeDefinitionId()
      Reference to the scope instance definition for which the audit instance was created (if available, might be null).

    • getExternalId

      String getExternalId()
      If this audit instance was created from an external system, this optional external id might be used to map to that external data object id, if necessary.

    • getType

      String getType()
      Returns the main type of this audit instance. The type and sub type might later be used for easy querying and filtering of the audit stream.

    • getSubType

      String getSubType()
      Returns the sub type of this audit instance. The type and sub type might later be used for easy querying and filtering of the audit stream.

    • getPayload

      Map<String,Object> getPayload()
      Returns the optional payload as a byte array for this audit instance as described within the AuditDefinition.

    • getCreationTime

      Date getCreationTime()
      Returns the creation timestamp of this audit instance.

    • getCreatorId

      String getCreatorId()
      Returns the id of the user creating this audit instance.