com.hpe.caf.worker.document.model

Interface Response

All Superinterfaces:

DocumentWorkerObject

public interface Response
extends DocumentWorkerObject

Used for customizing the response to the document processing task.

Not all response options are applicible to all types of tasks.

Method Summary

Modifier and Type	Method and Description
ResponseCustomData	getCustomData() Returns an object which can be used to manipulate the custom data that will be sent as a part of the response.
ResponseQueue	getFailureQueue() Returns the queue that the response will be published to if any failures are newly added to the document or to any of its subdocuments.
ResponseQueue	getSuccessQueue() Returns the queue that the response will be published to if it does not contain any new failures.
Task	getTask() Returns the task that this response customization object is associated with.

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

getApplication

Method Detail

getCustomData

@Nonnull
ResponseCustomData getCustomData()

Returns an object which can be used to manipulate the custom data that will be sent as a part of the response.

Returns:

the object that can be used to access or update the custom data in the response

getFailureQueue

@Nonnull
ResponseQueue getFailureQueue()

Returns the queue that the response will be published to if any failures are newly added to the document or to any of its subdocuments. Failures can be added to a document using the Document.addFailure() method or one of the Failures.add() methods.

Returns:

the queue that will be used if the response contains failures

getSuccessQueue

@Nonnull
ResponseQueue getSuccessQueue()

Returns the queue that the response will be published to if it does not contain any new failures.

Returns:

the queue that will be used if the response is successful

getTask

@Nonnull
Task getTask()

Returns the task that this response customization object is associated with.

Returns:

the task that this response customization object is associated with