com.hpe.caf.worker.document.model

Interface Subdocument

All Superinterfaces:

Document, DocumentWorkerObject

public interface Subdocument
extends Document

Represents a direct or indirect subdocument of the document being processed.

Subdocuments are documents in their own right and can also have fields, failures, and subdocuments of their own.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes this subdocument.
Document	getParentDocument() Returns the parent document of this subdocument.
boolean	isDeleted() Returns true if the subdocument has been deleted.

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

addFailure, getCustomData, getFailures, getField, getFields, getReference, getRootDocument, getSubdocuments, getTask, hasChanges, hasSubdocuments, reset, resetReference, setReference

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

getApplication

Method Detail

getParentDocument

@Nonnull
Document getParentDocument()

Returns the parent document of this subdocument.

Specified by:

getParentDocument in interface Document

Returns:

the document that is the parent of this subdocument

delete

void delete()

Deletes this subdocument.

After a subdocument has been deleted the Document.reset() method may still be used to restore it to its original state, but other methods which would query or manipulate the deleted document should not be called. Calling these methods will result in undefined behavior.

isDeleted

boolean isDeleted()

Returns true if the subdocument has been deleted.

Returns:

true if the subdocument has been deleted