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 by WorkflowValidator.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getElementValidationResults

      Map<ElementKey, IWorkflowElementValidationResult> getElementValidationResults()
      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 getUnhandledExceptions()), or the element was not scheduled to be validated.
      Returns:
      The validation results for each element.

    • getProcessValidationResult

      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. May be empty when the process was not validated.
      Returns:
      The validation result for the entire process.

    • getTaskValidationResults

      Map<UUID, IWorkflowElementValidationResult> getTaskValidationResults()
      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 getUnhandledExceptions()), or the task was not scheduled to be validated.
      Returns:
      The validation results for each task.

    • getUnhandledExceptions

      List<WorkflowValidationException> getUnhandledExceptions()
      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.
      Returns:
      All unhandled exceptions that occurred during validation.

    • isValid

      default boolean isValid()
      Checks whether there is at least one validation failure in the getElementValidationResults() or at least one exception in the getUnhandledExceptions().
      Returns:
      Whether there is no validation failure and no unhandled exception.