All Known Implementing Classes:

AuditInstanceBuilderImpl
```
public interface AuditInstanceBuilder
```
A builder to create new objects of type AuditInstance.

Author:

Micha Kiener

Method Summary

All Methods Instance Methods Abstract 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.
`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 `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.

- Method Detail
  - auditDefinitionId
```
AuditInstanceBuilder auditDefinitionId(String auditDefinitionId)
```
    Set the audit definition of this audit instance.
  - scopeId
```
AuditInstanceBuilder scopeId(String scopeId)
```
    Set the optional scope instance for which the audit instance was created.
  - subScopeId
```
AuditInstanceBuilder subScopeId(String subScopeId)
```
    Set the optional subScope instance for which the audit instance was created.
  - scopeType
```
AuditInstanceBuilder scopeType(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(String scopeDefinitionId)
```
    Set the scope instance definition for which the audit instance was created.
  - externalId
```
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.
  - tenantId
```
AuditInstanceBuilder tenantId(String tenantId)
```
    The tenantId for the audit instance.
  - type
```
AuditInstanceBuilder type(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(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(Map<String,Object> payload)
```
    Set the optional payload as a generic map representation for this audit instance as described within the AuditDefinition.
  - creatorId
```
AuditInstanceBuilder creatorId(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

Interface AuditInstanceBuilder

Method Summary

Method Detail

auditDefinitionId

scopeId

subScopeId

scopeType

scopeDefinitionId

externalId

tenantId

type

subType

payload

creatorId

create