Package com.flowable.audit.api.runtime

Interface AuditInstanceBuilder

All Known Implementing Classes:
AuditInstanceBuilderImpl
public interface AuditInstanceBuilder
A builder to create new objects of type AuditInstance.
Author:
Micha Kiener

  • Method Details

    • auditDefinitionId

      AuditInstanceBuilder auditDefinitionId​(java.lang.String auditDefinitionId)
      Set the audit definition of this audit instance.

    • scopeId

      AuditInstanceBuilder scopeId​(java.lang.String scopeId)
      Set the optional scope instance for which the audit instance was created.

    • subScopeId

      AuditInstanceBuilder subScopeId​(java.lang.String subScopeId)
      Set the optional subScope instance for which the audit instance was created.

    • scopeType

      AuditInstanceBuilder scopeType​(java.lang.String scopeType)
      Set the optional scope instance type for which the audit instance was created (must be set if scopeId(String) is set).

    • scopeDefinitionId

      AuditInstanceBuilder scopeDefinitionId​(java.lang.String scopeDefinitionId)
      Set the scope instance definition for which the audit instance was created.

    • externalId

      AuditInstanceBuilder externalId​(java.lang.String externalId)
      If this audit instance was created from an external system, set this optional external id to map to that external data object id, if necessary.

    • tenantId

      AuditInstanceBuilder tenantId​(java.lang.String tenantId)
      The tenantId for the audit instance.

    • type

      AuditInstanceBuilder type​(java.lang.String type)
      Set 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.

    • subType

      AuditInstanceBuilder subType​(java.lang.String subType)
      Set 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.

    • payload

      AuditInstanceBuilder payload​(java.util.Map<java.lang.String,​java.lang.Object> payload)
      Set the optional payload as a generic map representation for this audit instance as described within the AuditDefinition.

    • creatorId

      AuditInstanceBuilder creatorId​(java.lang.String creatorId)
      Set the optional creator id. If no creator id is set, currently authenticated user is used.

    • create

      AuditInstance create()
      Creates and persists the AuditInstance according the data provided to this builder.
      Returns:
      the newly created and persisted audit instance