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 TypeMethodDescriptionReference to the audit definition of this audit instance.Returns the creation timestamp of this audit instance.Returns the id of the user creating this audit instance.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.getId()
The unique, technical id of this audit instance object.Returns the optional payload as a byte array for this audit instance as described within theAuditDefinition
.Reference to the scope instance definition for which the audit instance was created (if available, might benull
).Reference to the optional scope instance for which the audit instance was created, if any, as this is optional, it might benull
.Type of the optional scope instance for which the audit instance was created (only, ifgetScopeId()
is set).Reference to the optional sub scope instance for which the audit instance was created, if any, as this is optional, it might benull
.Returns the sub type of this audit instance.Returns the id of the tenant this audit instance object belongs to.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 benull
. -
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 benull
. -
getScopeType
String getScopeType()Type of the optional scope instance for which the audit instance was created (only, ifgetScopeId()
is set). -
getScopeDefinitionId
String getScopeDefinitionId()Reference to the scope instance definition for which the audit instance was created (if available, might benull
). -
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
Returns the optional payload as a byte array for this audit instance as described within theAuditDefinition
. -
getCreationTime
Date getCreationTime()Returns the creation timestamp of this audit instance. -
getCreatorId
String getCreatorId()Returns the id of the user creating this audit instance.
-