com.hpe.caf.worker.document.model

Interface Failure

All Superinterfaces:

DocumentWorkerObject

public interface Failure
extends DocumentWorkerObject

Represents a failure attached to the document.

Method Summary

Modifier and Type	Method and Description
Document	getDocument() Returns the document that this failure is associated with.
String	getFailureId() Returns the non-localisable identifier related to the failure.
String	getFailureMessage() Returns a human readable message relating to the failure.
String	getFailureStack() Returns the stack trace relating to the failure, or null if it was not recorded.

Methods inherited from interface com.hpe.caf.worker.document.model.DocumentWorkerObject

getApplication

Method Detail

getDocument

@Nonnull
Document getDocument()

Returns the document that this failure is associated with.

Returns:

the document that this failure is associated with

getFailureId

String getFailureId()

Returns the non-localisable identifier related to the failure.

Returns:

the non-localisable identifier related to the failure

getFailureMessage

String getFailureMessage()

Returns a human readable message relating to the failure.

Returns:

a human readable message relating to the failure

getFailureStack

String getFailureStack()

Returns the stack trace relating to the failure, or null if it was not recorded.

Returns:

the stack trace relating to the failure