com.hpe.caf.worker.document.model

Interface Task

All Superinterfaces:

DocumentWorkerObject

public interface Task
extends DocumentWorkerObject

Represents the document processing task.

The task includes a document or a partial document to be processed, as well as some custom data which may include processing instructions.

Method Summary

Modifier and Type	Method and Description
String	getCustomData(String dataKey) Used to retrieve any custom data that was sent with the task.
Document	getDocument() Returns the document to be processed by this task.
Response	getResponse() Returns an object which can be used to customise the response to the document processing task.
Scripts	getScripts() Gets the list of customization scripts associated with this task.
<S> S	getService(Class<S> service) Returns the specified task-level service, or null if the service has not been registered.

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

getApplication

Method Detail

getCustomData

String getCustomData(String dataKey)

Used to retrieve any custom data that was sent with the task. The custom data could be used to send processing instructions to the worker, to affect how the document is processed.

Parameters:

dataKey - the key of the data to be retrieved (note that the key lookup is case-sensitive)

Returns:

the value retrieved if it was sent, or null if no data was sent with the specified key

getDocument

@Nonnull
Document getDocument()

Returns the document to be processed by this task.

Returns:

the document to be processed by this task

getScripts

@Nonnull
Scripts getScripts()

Gets the list of customization scripts associated with this task.

Scripts are ordered and can be accessed by index.

Returns:

an object which can be used to access the list of scripts

getService

<S> S getService(Class<S> service)

Returns the specified task-level service, or null if the service has not been registered.

This method can be used to access task-level services that are provided by the underlying Worker Framework but not exposed by the Document Worker Framework.

For example, to access the Worker Framework WorkerTaskData object add the following dependency to the project POM:

  <dependency>
      <groupId>com.github.workerframework</groupId>
      <artifactId>worker-api</artifactId>
      <scope>provided</scope>
  </dependency>

and then retrieve the object using this method:

  WorkerTaskData workerTask = documentTask.getService(WorkerTaskData.class);

Type Parameters:

S - the type of the service to be returned

Parameters:

service - the interface or abstract class representing the service

Returns:

the service provider

See Also:

Application.getService()

getResponse

@Nonnull
Response getResponse()

Returns an object which can be used to customise the response to the document processing task.

Returns:

the response customization object for this task