Class WorkflowValidationResult

java.lang.Object

de.xima.fc.workflow.processor.model.WorkflowValidationResult

All Implemented Interfaces:

IWorkflowValidationResult, Serializable

public final class WorkflowValidationResult
extends Object
implements IWorkflowValidationResult

POJO implementation of a IWorkflowValidationResult.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WorkflowValidationResult(IWorkflowElementValidationResult processValidationResult, Map<UUID, IWorkflowElementValidationResult> taskValidationResults, Map<ElementKey, IWorkflowElementValidationResult> elementValidationResults, List<WorkflowValidationException> unhandledExceptions)	Creates a new POJO with the given data.

Method Summary

Modifier and Type	Method	Description
Map<ElementKey, IWorkflowElementValidationResult>	getElementValidationResults()	Gets the map between the key of a validated workflow element and the validation result for that element.
IWorkflowElementValidationResult	getProcessValidationResult()	Gets the validation result for the entire process, i.e. validation messages that pertain to the entire process, e.g. that the process must contain at least one task.
Map<UUID, IWorkflowElementValidationResult>	getTaskValidationResults()	Get the map between the UUID of a workflow task and the validation result for that task.
List<WorkflowValidationException>	getUnhandledExceptions()	Gets all unhandled exception that occurred during validation.
static IWorkflowValidationResult	ofError(Throwable throwable)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IWorkflowValidationResult

isValid

Constructor Details

WorkflowValidationResult

public WorkflowValidationResult(IWorkflowElementValidationResult processValidationResult,
 Map<UUID, IWorkflowElementValidationResult> taskValidationResults,
 Map<ElementKey, IWorkflowElementValidationResult> elementValidationResults,
 List<WorkflowValidationException> unhandledExceptions)

Creates a new POJO with the given data.

Parameters:

processValidationResult - Value returned by IWorkflowValidationResult.getProcessValidationResult()

taskValidationResults - Value returned by IWorkflowValidationResult.getTaskValidationResults()

elementValidationResults - Value returned by IWorkflowValidationResult.getElementValidationResults()

unhandledExceptions - Value returned by IWorkflowValidationResult.getUnhandledExceptions().

Method Details

getElementValidationResults

public Map<ElementKey, IWorkflowElementValidationResult> getElementValidationResults()

Description copied from interface: IWorkflowValidationResult

Gets the map between the key of a validated workflow element and the validation result for that element. If an element does not appear in this map, either an exception was thrown during its validation (see IWorkflowValidationResult.getUnhandledExceptions()), or the element was not scheduled to be validated.

Specified by:

getElementValidationResults in interface IWorkflowValidationResult

Returns:

The validation results for each element.

getProcessValidationResult

public IWorkflowElementValidationResult getProcessValidationResult()

Description copied from interface: IWorkflowValidationResult

Gets the validation result for the entire process, i.e. validation messages that pertain to the entire process, e.g. that the process must contain at least one task. May be empty when the process was not validated.

Specified by:

getProcessValidationResult in interface IWorkflowValidationResult

Returns:

The validation result for the entire process.

getTaskValidationResults

public Map<UUID, IWorkflowElementValidationResult> getTaskValidationResults()

Description copied from interface: IWorkflowValidationResult

Get the map between the UUID of a workflow task and the validation result for that task. If a task does not appear in this map, either an exception was thrown during its validation (see IWorkflowValidationResult.getUnhandledExceptions()), or the task was not scheduled to be validated.

Specified by:

getTaskValidationResults in interface IWorkflowValidationResult

Returns:

The validation results for each task.

getUnhandledExceptions

public List<WorkflowValidationException> getUnhandledExceptions()

Description copied from interface: IWorkflowValidationResult

Gets all unhandled exception that occurred during validation. No error messages may be generated in case this contains any exceptions, however, the workflow process, task, or node should be regarded as invalid and should not be persisted.

Specified by:

getUnhandledExceptions in interface IWorkflowValidationResult

Returns:

All unhandled exceptions that occurred during validation.

ofError

public static IWorkflowValidationResult ofError(Throwable throwable)

Parameters:

throwable - Unhandled exception that occurred and caused the validation process to fail.

Returns:

A new POJO with no validations results and the given unhandled exception.