com.hpe.caf.worker.document.model

Interface Document

All Superinterfaces:

DocumentWorkerObject

All Known Subinterfaces:

Subdocument

public interface Document
extends DocumentWorkerObject

Represents a document being processed.

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

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.
Failures	getFailures() Gets the collection of failures that are currently associated with the document.
Field	getField(String fieldName) Gets a field object for the specified field.
Fields	getFields() Gets the list of fields currently associated with the document.
Document	getParentDocument() Returns the parent document of this document, or null if this document does not have a parent document.
String	getReference() Returns the reference that is associated with the document.
Document	getRootDocument() Returns the root document of this document's hierarchy.
Subdocuments	getSubdocuments() Gets the list of subdocuments currently associated with the document.
Task	getTask() Returns the task that is associated with the document.
boolean	hasChanges() Returns true if the document has been modified from its original state.
boolean	hasSubdocuments() Returns true if this document currently has any child subdocuments.
void	reset() Resets the document, and all of its subdocuments, back to its original state, undoing any modifications that have been made to the document.
void	resetReference() Resets the reference back to its original state, undoing any changes made to it using the setReference() method.
void	setReference(String reference) Sets the reference that should be associated with the document.

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

getApplication

Method Detail

getTask

@Nonnull
Task getTask()

Returns the task that is associated with the document.

Returns:

the task that is associated with the document

getReference

String getReference()

Returns the reference that is associated with the document.

Returns:

the reference that is associated with the document

setReference

void setReference(String reference)

Sets the reference that should be associated with the document.

Parameters:

reference - the reference to be associated with the document

resetReference

void resetReference()

Resets the reference back to its original state, undoing any changes made to it using the setReference() method.

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

getFailures

@Nonnull
Failures getFailures()

Gets the collection of failures that are currently associated with the document.

Returns:

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

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

getParentDocument

Document getParentDocument()

Returns the parent document of this document, or null if this document does not have a parent document.

Returns:

the document that is the parent of this document

getRootDocument

@Nonnull
Document getRootDocument()

Returns the root document of this document's hierarchy. If this document is the root document of the hierarchy then calling this method will return itself.

Returns:

the root of the document hierarchy

getSubdocuments

@Nonnull
Subdocuments getSubdocuments()

Gets the list of subdocuments currently associated with the document.

Subdocuments are ordered and can be accessed by index. If a subdocument is deleted then it is immediately removed from the list, causing the indexes of the subdocuments following it to be changed.

Returns:

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

hasSubdocuments

boolean hasSubdocuments()

Returns true if this document currently has any child subdocuments.

Returns:

true if this document currently has any child subdocuments

hasChanges

boolean hasChanges()

Returns true if the document has been modified from its original state.

Returns:

true if the document has been modified from its original state

reset

void reset()

Resets the document, and all of its subdocuments, back to its original state, undoing any modifications that have been made to the document.