java.lang.Object
- com.flowable.audit.engine.impl.runtime.AuditInstanceBuilderImpl

All Implemented Interfaces:: AuditInstanceBuilder

public class AuditInstanceBuilderImpl
extends Object
implements AuditInstanceBuilder

Author:: Tijs Rademakers, Joram Barrez

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`auditDefinitionId`
`protected AuditServiceImpl`	`auditService`
`protected String`	`creatorId`
`protected String`	`externalId`
`protected Map<String,Object>`	`payload`
`protected String`	`scopeDefinitionId`
`protected String`	`scopeId`
`protected String`	`scopeType`
`protected String`	`subScopeId`
`protected String`	`subType`
`protected String`	`tenantId`
`protected String`	`type`

Constructor Summary

Constructors
Constructor Description

AuditInstanceBuilderImpl(AuditServiceImpl auditService)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AuditInstanceBuilder`	`auditDefinitionId(String auditDefinitionId)`	Set the audit definition of this audit instance.
`AuditInstance`	`create()`	Creates and persists the `AuditInstance` according the data provided to this builder.
`AuditInstanceBuilder`	`creatorId(String creatorId)`	Set the optional creator id.
`AuditInstanceBuilder`	`externalId(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.
`String`	`getAuditDefinitionId()`
`AuditService`	`getAuditService()`
`String`	`getCreatorId()`
`String`	`getExternalId()`
`Map<String,Object>`	`getPayload()`
`String`	`getScopeDefinitionId()`
`String`	`getScopeId()`
`String`	`getScopeType()`
`String`	`getSubScopeId()`
`String`	`getSubType()`
`String`	`getTenantId()`
`String`	`getType()`
`AuditInstanceBuilder`	`payload(Map<String,Object> payload)`	Set the optional payload as a generic map representation for this audit instance as described within the `AuditDefinition`.
`AuditInstanceBuilder`	`scopeDefinitionId(String scopeDefinitionId)`	Set the scope instance definition for which the audit instance was created.
`AuditInstanceBuilder`	`scopeId(String scopeId)`	Set the optional scope instance for which the audit instance was created.
`AuditInstanceBuilder`	`scopeType(String scopeType)`	Set the optional scope instance type for which the audit instance was created (must be set if `AuditInstanceBuilder.scopeId(String)` is set).
`AuditInstanceBuilder`	`subScopeId(String subScopeId)`	Set the optional subScope instance for which the audit instance was created.
`AuditInstanceBuilder`	`subType(String subType)`	Set the sub type of this audit instance.
`AuditInstanceBuilder`	`tenantId(String tenantId)`	The tenantId for the audit instance.
`AuditInstanceBuilder`	`type(String type)`	Set the main type of this audit instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - auditService
```
protected AuditServiceImpl auditService
```
  - auditDefinitionId
```
protected String auditDefinitionId
```
  - scopeId
```
protected String scopeId
```
  - subScopeId
```
protected String subScopeId
```
  - scopeType
```
protected String scopeType
```
  - scopeDefinitionId
```
protected String scopeDefinitionId
```
  - externalId
```
protected String externalId
```
  - tenantId
```
protected String tenantId
```
  - type
```
protected String type
```
  - subType
```
protected String subType
```
  - payload
```
protected Map<String,Object> payload
```
  - creatorId
```
protected String creatorId
```
- Constructor Detail
  - AuditInstanceBuilderImpl
```
public AuditInstanceBuilderImpl(AuditServiceImpl auditService)
```
- Method Detail
  - auditDefinitionId
```
public AuditInstanceBuilder auditDefinitionId(String auditDefinitionId)
```
    Description copied from interface: AuditInstanceBuilder
    
    Set the audit definition of this audit instance.
    
    Specified by:
    
    auditDefinitionId in interface AuditInstanceBuilder
  - scopeId
```
public AuditInstanceBuilder scopeId(String scopeId)
```
    Description copied from interface: AuditInstanceBuilder
    
    Set the optional scope instance for which the audit instance was created.
    
    Specified by:
    
    scopeId in interface AuditInstanceBuilder
  - subScopeId
```
public AuditInstanceBuilder subScopeId(String subScopeId)
```
    Description copied from interface: AuditInstanceBuilder
    
    Set the optional subScope instance for which the audit instance was created.
    
    Specified by:
    
    subScopeId in interface AuditInstanceBuilder
  - scopeType
```
public AuditInstanceBuilder scopeType(String scopeType)
```
    Description copied from interface: AuditInstanceBuilder
    
    Set the optional scope instance type for which the audit instance was created (must be set if AuditInstanceBuilder.scopeId(String) is set).
    
    Specified by:
    
    scopeType in interface AuditInstanceBuilder
  - scopeDefinitionId
```
public AuditInstanceBuilder scopeDefinitionId(String scopeDefinitionId)
```
    Description copied from interface: AuditInstanceBuilder
    
    Set the scope instance definition for which the audit instance was created.
    
    Specified by:
    
    scopeDefinitionId in interface AuditInstanceBuilder
  - externalId
```
public AuditInstanceBuilder externalId(String externalId)
```
    Description copied from interface: AuditInstanceBuilder
    
    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.
    
    Specified by:
    
    externalId in interface AuditInstanceBuilder
  - tenantId
```
public AuditInstanceBuilder tenantId(String tenantId)
```
    Description copied from interface: AuditInstanceBuilder
    
    The tenantId for the audit instance.
    
    Specified by:
    
    tenantId in interface AuditInstanceBuilder
  - type
```
public AuditInstanceBuilder type(String type)
```
    Description copied from interface: AuditInstanceBuilder
    
    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.
    
    Specified by:
    
    type in interface AuditInstanceBuilder
  - subType
```
public AuditInstanceBuilder subType(String subType)
```
    Description copied from interface: AuditInstanceBuilder
    
    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.
    
    Specified by:
    
    subType in interface AuditInstanceBuilder
  - payload
```
public AuditInstanceBuilder payload(Map<String,Object> payload)
```
    Description copied from interface: AuditInstanceBuilder
    
    Set the optional payload as a generic map representation for this audit instance as described within the AuditDefinition.
    
    Specified by:
    
    payload in interface AuditInstanceBuilder
  - creatorId
```
public AuditInstanceBuilder creatorId(String creatorId)
```
    Description copied from interface: AuditInstanceBuilder
    
    Set the optional creator id. If no creator id is set, currently authenticated user is used.
    
    Specified by:
    
    creatorId in interface AuditInstanceBuilder
  - create
```
public AuditInstance create()
```
    Description copied from interface: AuditInstanceBuilder
    
    Creates and persists the AuditInstance according the data provided to this builder.
    
    Specified by:
    
    create in interface AuditInstanceBuilder
    
    Returns:
    
    the newly created and persisted audit instance
  - getAuditService
```
public AuditService getAuditService()
```
  - getAuditDefinitionId
```
public String getAuditDefinitionId()
```
  - getScopeId
```
public String getScopeId()
```
  - getSubScopeId
```
public String getSubScopeId()
```
  - getScopeType
```
public String getScopeType()
```
  - getScopeDefinitionId
```
public String getScopeDefinitionId()
```
  - getExternalId
```
public String getExternalId()
```
  - getTenantId
```
public String getTenantId()
```
  - getType
```
public String getType()
```
  - getSubType
```
public String getSubType()
```
  - getPayload
```
public Map<String,Object> getPayload()
```
  - getCreatorId
```
public String getCreatorId()
```

Class AuditInstanceBuilderImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

auditService

auditDefinitionId

scopeId

subScopeId

scopeType

scopeDefinitionId

externalId

tenantId

type

subType

payload

creatorId

Constructor Detail

AuditInstanceBuilderImpl

Method Detail

auditDefinitionId

scopeId

subScopeId

scopeType

scopeDefinitionId

externalId

tenantId

type

subType

payload

creatorId

create

getAuditService

getAuditDefinitionId

getScopeId

getSubScopeId

getScopeType

getScopeDefinitionId

getExternalId

getTenantId

getType

getSubType

getPayload

getCreatorId