com.hpe.caf.worker.document.model

Interface Failures

All Superinterfaces:

DocumentWorkerObject, Iterable<Failure>

public interface Failures
extends DocumentWorkerObject, Iterable<Failure>

Represents the collection of failures that are attached to a document. Each failure has a non-localisable identifier as well as a human readable message and optionally a stack trace.

Method Summary

Modifier and Type	Method and Description
void	add(String failureId, String failureMessage) Adds the specified failure.
void	add(String failureId, String failureMessage, Throwable cause) Adds the specified failure.
void	clear() Removes all the failures in this collection.
Document	getDocument() Returns the document that this collection of failures is associated with.
boolean	isChanged() Returns true if this collection has been modified from its original state.
boolean	isEmpty() Returns true if there are no failures in this collection.
void	reset() Resets this collection of failures back to its original state, undoing any changes made to it using the add() or clear() methods.
int	size() Returns the number of failures in this collection.
Stream<Failure>	stream() Returns a sequential Stream with this failures collection as its source.

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

getApplication

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

add

void add(String failureId,
         String failureMessage)

Adds the specified failure.

Parameters:

failureId - a non-localisable identifier related to the failure

failureMessage - a human readable message relating to the failure

add

void add(String failureId,
         String failureMessage,
         Throwable cause)

Adds the specified failure.

Parameters:

failureId - a non-localisable identifier related to the failure

failureMessage - a human readable message relating to the failure

cause - the cause of the failure

clear

void clear()

Removes all the failures in this collection.

getDocument

@Nonnull
Document getDocument()

Returns the document that this collection of failures is associated with.

Returns:

the document that this collection of failures is associated with

isChanged

boolean isChanged()

Returns true if this collection has been modified from its original state.

Returns:

true if this collection has been modified from its original state

isEmpty

boolean isEmpty()

Returns true if there are no failures in this collection.

Returns:

true if there are no failures in this collection

reset

void reset()

Resets this collection of failures back to its original state, undoing any changes made to it using the add() or clear() methods.

size

int size()

Returns the number of failures in this collection.

Returns:

the number of failures in this collection

stream

@Nonnull
Stream<Failure> stream()

Returns a sequential Stream with this failures collection as its source.

Returns:

a sequential Stream over the collection of failures