Interface IWorkflowValidationResult
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
WorkflowValidationResult
public interface IWorkflowValidationResult extends Serializable
Describes the result of a workflow validation process, as produced byWorkflowValidator
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Map<ElementKey,IWorkflowElementValidationResult>
getElementValidationResults()
Optional<IWorkflowElementValidationResult>
getProcessValidationResult()
Map<UUID,IWorkflowElementValidationResult>
getTaskValidationResults()
List<WorkflowValidationException>
getUnhandledExceptions()
default boolean
isValid()
-
-
-
Method Detail
-
getElementValidationResults
Map<ElementKey,IWorkflowElementValidationResult> getElementValidationResults()
- Returns:
- A 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
getUnhandledExceptions()
, or the element was not scheduled to be validated.
-
getProcessValidationResult
Optional<IWorkflowElementValidationResult> getProcessValidationResult()
- Returns:
- 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.
-
getTaskValidationResults
Map<UUID,IWorkflowElementValidationResult> getTaskValidationResults()
- Returns:
- A 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
getUnhandledExceptions()
, or the task was not scheduled to be validated.
-
getUnhandledExceptions
List<WorkflowValidationException> getUnhandledExceptions()
- Returns:
- 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.
-
isValid
default boolean isValid()
- Returns:
- Whether there is at least one validation failure in the
getElementValidationResults()
or at least one exception in thegetUnhandledExceptions()
.
-
-