AuditDetail (platform/sdk 5.5.1.0-SNAPSHOT API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

MockIngestApi.MockAuditDetail
```
public interface AuditDetail
extends Serializable
```
Base interface for all AIE message and document audit information.
$Revision$

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getAncestorId()` The initiating document id if any.
`UUID`	`getClientId()`
`String`	`getComponent()`
`UUID`	`getCorrelationId()` The unique id for a document update.
`Date`	`getDate()`
`DocumentMode`	`getDocumentMode()` The `DocumentMode` for the document.
`ErrorCode`	`getErrorCode()`
`String`	`getErrorMessage()` Returns the unstructured error message associated with a processing error.
`String`	`getExceptionClass()`
`String`	`getId()` The id (message or document) associated with the audit detail record.
`String`	`getMessageClass()` Message class associated with the audit detail.
`String`	`getNode()` k
`String`	`getParentId()` The immediate parent document id if any.
`ProcessingResultCode`	`getResultCode()`
`long`	`getSequenceId()` This value has meaning only after retrieval from the audit store.

- Method Detail
  - getSequenceId
```
long getSequenceId()
```
    This value has meaning only after retrieval from the audit store.
    
    Returns:
    
    The sequence ID for the detail record, -1 if undefined
  - getDate
```
Date getDate()
```
    Returns:
    
    the date the audit record was generated.
  - getClientId
```
UUID getClientId()
```
    Returns:
    
    the client associated with the detail.
  - getMessageClass
```
String getMessageClass()
```
    Message class associated with the audit detail. May be null for the common case of document bearing messages.
  - getId
```
String getId()
```
    The id (message or document) associated with the audit detail record.
  - getCorrelationId
```
UUID getCorrelationId()
```
    The unique id for a document update.
  - getResultCode
```
ProcessingResultCode getResultCode()
```
    Returns:
    
    ProcessingResultCode for the audit detail record.
  - getNode
```
String getNode()
```
    k
    
    Returns:
    
    the name of the node where the audit information was generated
  - getAncestorId
```
String getAncestorId()
```
    The initiating document id if any. For instance, for a document contained in a zip (inner.zip) contained in a zip ( main.zip), this ID would be the main.zip
  - getParentId
```
String getParentId()
```
    The immediate parent document id if any. For instance, for a document contained in a zip (inner.zip) contained in a zip (main.zip), this ID would be the inner.zip
  - getDocumentMode
```
DocumentMode getDocumentMode()
```
    The DocumentMode for the document.
  - getComponent
```
String getComponent()
```
    Returns:
    
    null if created by client
  - getErrorCode
```
ErrorCode getErrorCode()
```
    Returns:
    
    null if no ErrorCode was recorded, the error code otherwise.
  - getExceptionClass
```
String getExceptionClass()
```
    Returns:
    
    null if no Exception was recorded, the simple name of the exception class otherwise.
  - getErrorMessage
```
String getErrorMessage()
```
    Returns the unstructured error message associated with a processing error.

Interface AuditDetail

Method Summary

Method Detail

getSequenceId

getDate

getClientId

getMessageClass

getId

getCorrelationId

getResultCode

getNode

getAncestorId

getParentId

getDocumentMode

getComponent

getErrorCode

getExceptionClass

getErrorMessage