Package com.hpe.caf.worker.document.model

This package defines a set of objects which are made available by the Document Worker Framework.

See: Description

Interface Summary

Interface	Description
Application	Represents the entire service.
BatchSizeController	Used for controlling the sizes of the batches passed to implementations of the BulkDocumentWorker interface.
Document	Represents a document being processed.
Documents	Represents a batch of documents to be processed.
DocumentWorkerObject	This is the base object of the Document Worker Object Model.
Failure	Represents a failure attached to the document.
Failures	Represents the collection of failures that are attached to a document.
Field	Represents a field of the document.
Fields	Represents the collection of fields that are attached to a document.
FieldValue	Represents one of the data values of a field.
FieldValues	Represents the collection of data values that belong to a field.
HealthMonitor	Used for reporting any health issues detected.
InputMessageProcessor	Used for controlling how messages that are received from the input queue are processed.
Response	Used for customizing the response to the document processing task.
ResponseCustomData	Represents the custom data that is sent as part of the response to the document processing task.
ResponseQueue	Used for managing the queue that response messages are published to.
Script	Represents a customization script which is attached to a task.
Scripts	Represents the list of customization scripts which are attached to a task.
ServiceLocator	Used for caching and loading extra services that may be made available.
Subdocument	Represents a direct or indirect subdocument of the document being processed.
Subdocuments	Represents the list of subdocuments that are attached to a document.
Task	Represents the document processing task.

Enum Summary

Enum	Description
ScriptEngineType	Scripting engines supported by the Document Worker Framework.

Package com.hpe.caf.worker.document.model Description

This package defines a set of objects which are made available by the Document Worker Framework.

All of the objects in this package inherit from DocumentWorkerObject.

New methods being added to the interfaces in this package is not considered to constitute a breaking change as workers built on the Document Worker Framework are not expected to implement these interfaces themselves; rather they are expected to be implemented by framework objects.