Package com.attivio.sdk.client.audit

Interface AuditDetail

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    MockIngestApi.MockAuditDetail
    public interface AuditDetail
extends java.io.Serializable
    Base interface for all AIE message and document audit information.

    $Revision$

    • 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

        java.util.Date getDate()
        Returns:
        the date the audit record was generated.

      • getClientId

        java.util.UUID getClientId()
        Returns:
        the client associated with the detail.

      • getMessageClass

        java.lang.String getMessageClass()
        Message class associated with the audit detail. May be null for the common case of document bearing messages.

      • getId

        java.lang.String getId()
        The id (message or document) associated with the audit detail record.

      • getCorrelationId

        java.util.UUID getCorrelationId()
        The unique id for a document update.

      • getResultCode

        ProcessingResultCode getResultCode()
        Returns:
        ProcessingResultCode for the audit detail record.

      • getNode

        java.lang.String getNode()
        k
        Returns:
        the name of the node where the audit information was generated

      • getAncestorId

        java.lang.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

        java.lang.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

      • getComponent

        java.lang.String getComponent()
        Returns:
        null if created by client

      • getErrorCode

        ErrorCode getErrorCode()
        Returns:
        null if no ErrorCode was recorded, the error code otherwise.

      • getExceptionClass

        java.lang.String getExceptionClass()
        Returns:
        null if no Exception was recorded, the simple name of the exception class otherwise.

      • getErrorMessage

        java.lang.String getErrorMessage()
        Returns the unstructured error message associated with a processing error.