Package com.scivicslab.pojoactor.workflow

Class MatrixCode

java.lang.Object
com.scivicslab.pojoactor.workflow.MatrixCode
public class MatrixCode extends Object
Represents a matrix-based workflow definition.

A MatrixCode contains a name and a list of Transition objects that define the workflow's state transitions and actions. Each transition in the matrix represents a state change with associated actions to execute.

This class is designed to be populated from YAML or JSON workflow definitions using deserialization frameworks like SnakeYAML or Jackson.

Author:
devteam@scivicslab.com

  • Constructor Details

    • MatrixCode

      public MatrixCode()
      Constructs an empty MatrixCode.

      This no-argument constructor is required for deserialization.

  • Method Details

    • getName

      public String getName()
      Returns the name of this workflow.
      Returns:
      the workflow name

    • setName

      public void setName(String name)
      Sets the name of this workflow.
      Parameters:
      name - the workflow name

    • getDescription

      public String getDescription()
      Returns the description of this workflow.

      The description provides human-readable documentation about what the workflow does. It is optional and not used at runtime.

      Returns:
      the workflow description, or null if not set

    • setDescription

      public void setDescription(String description)
      Sets the description of this workflow.
      Parameters:
      description - the workflow description

    • getTransitions

      public List<Transition> getTransitions()
      Returns the workflow transitions.
      Returns:
      a list of Transition objects representing the workflow transitions
      Since:
      2.12.0

    • setTransitions

      public void setTransitions(List<Transition> transitions)
      Sets the workflow transitions.
      Parameters:
      transitions - a list of Transition objects representing the workflow transitions
      Since:
      2.12.0

    • getSteps

      public List<Transition> getSteps()
      Returns the workflow transitions (alias for YAML 'steps' key).
      Returns:
      a list of Transition objects
      Since:
      2.12.0

    • setSteps

      public void setSteps(List<Transition> steps)
      Sets the workflow transitions (alias for YAML 'steps' key).
      Parameters:
      steps - a list of Transition objects
      Since:
      2.12.0