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
`java.lang.String`	`getAuditDefinitionId()`	Reference to the audit definition of this audit instance.
`java.util.Date`	`getCreationTime()`	Returns the creation timestamp of this audit instance.
`java.lang.String`	`getCreatorId()`	Returns the id of the user creating this audit instance.
`java.lang.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.
`java.lang.String`	`getId()`	The unique, technical id of this audit instance object.
`java.util.Map<java.lang.String,java.lang.Object>`	`getPayload()`	Returns the optional payload as a byte array for this audit instance as described within the `AuditDefinition`.
`java.lang.String`	`getScopeDefinitionId()`	Reference to the scope instance definition for which the audit instance was created (if available, might be `null`).
`java.lang.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`.
`java.lang.String`	`getScopeType()`	Type of the optional scope instance for which the audit instance was created (only, if `getScopeId()` is set).
`java.lang.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`.
`java.lang.String`	`getSubType()`	Returns the sub type of this audit instance.
`java.lang.String`	`getTenantId()`	Returns the id of the tenant this audit instance object belongs to.
`java.lang.String`	`getType()`	Returns the main type of this audit instance.

Method Details
- getTenantId
  
  java.lang.String getTenantId()
  
  Returns the id of the tenant this audit instance object belongs to.
- getId
  
  java.lang.String getId()
  
  The unique, technical id of this audit instance object.
- getAuditDefinitionId
  
  java.lang.String getAuditDefinitionId()
  
  Reference to the audit definition of this audit instance.
- getScopeId
  
  java.lang.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
  
  java.lang.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
  
  java.lang.String getScopeType()
  
  Type of the optional scope instance for which the audit instance was created (only, if getScopeId() is set).
- getScopeDefinitionId
  
  java.lang.String getScopeDefinitionId()
  
  Reference to the scope instance definition for which the audit instance was created (if available, might be null).
- getExternalId
  
  java.lang.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
  
  java.lang.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
  
  java.lang.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
  
  java.util.Map<java.lang.String,java.lang.Object> getPayload()
  
  Returns the optional payload as a byte array for this audit instance as described within the AuditDefinition.
- getCreationTime
  
  java.util.Date getCreationTime()
  
  Returns the creation timestamp of this audit instance.
- getCreatorId
  
  java.lang.String getCreatorId()
  
  Returns the id of the user creating this audit instance.

Interface AuditInstance

Method Summary

Method Details