com.hpe.caf.worker.document.model

Interface Document

All Superinterfaces:

DocumentWorkerObject

public interface Document
extends DocumentWorkerObject

Represents a document being processed.

The document has fields associated with it which may be manipulated when it is processed. Additionally it may also have custom data associated with it. This custom data can be used to affect how the document is processed without actually becoming metadata of the document.

If there is a failure processing the document then the failure information may also be stored with the document.

Method Summary

Modifier and Type	Method and Description
void	addFailure(String failureId, String failureMessage) Records the specified failure on the document.
String	getCustomData(String dataKey) Used to retrieve any custom data that was sent with the document, but which is not technically part of it.
Field	getField(String fieldName) Gets a field object for the specified field.
Fields	getFields() Gets the list of fields currently associated with the document.

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

getApplication

Method Detail

getFields

@Nonnull
Fields getFields()

Gets the list of fields currently associated with the document. This includes both fields which have been added to the document and fields which have been removed from the document. As it includes fields which have been removed from the document you may find that some of the fields have no values associated with them.

Returns:

an object which can be used to access the collection of fields

getField

@Nonnull
Field getField(String fieldName)

Gets a field object for the specified field. This can be used to read the data values currently associated with the field, or to add or replace the data values.

Parameters:

fieldName - the name of the field to access

Returns:

the object that can be used to access or update the field

getCustomData

String getCustomData(String dataKey)

Used to retrieve any custom data that was sent with the document, but which is not technically part of it.

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

addFailure

void addFailure(String failureId,
                String failureMessage)

Records the specified failure on the document.

Parameters:

failureId - a non localisable identifier related to the failure

failureMessage - a human readable message relating to the failure