Interface WorkflowModel

  • All Superinterfaces:
    HasMetaData

    public interface WorkflowModel
    extends HasMetaData
    WorkflowModel represents a model/definition of a workflow. It provides methods for retrieving the entities of the model like WorkflowNodes and WorkflowTransitions as well as common model attributes like name, description or version.
    • Method Detail

      • getId

        java.lang.String getId()
        Returns the ID of the WorkflowModel.
        Returns:
        The ID of the WorkflowModel.
      • getTitle

        java.lang.String getTitle()
        Returns the title of the WorkflowModel.
        Returns:
        The title of the WorkflowModel.
      • setTitle

        void setTitle​(java.lang.String title)
        Sets the title of the WorkflowModel.
        Parameters:
        title - The new title of the WorkflowModel.
      • getDescription

        java.lang.String getDescription()
        Returns the description of the WorkflowModel.
        Returns:
        The description of the WorkflowModel.
      • setDescription

        void setDescription​(java.lang.String description)
        Sets the description of the WorkflowModel.
        Parameters:
        description - The new description of the WorkflowModel.
      • getVersion

        java.lang.String getVersion()
        Returns the version of the WorkflowModel.
        Returns:
        The version of the WorkflowModel.
      • createNode

        WorkflowNode createNode​(java.lang.String title,
                                java.lang.String type,
                                java.lang.String description)
        Creates and returns a WorkflowNode
        Parameters:
        title - Title of node created
        type - Type of node created
        description - Description of node created
        Returns:
        The WorkflowNode created
      • setRootNode

        void setRootNode​(WorkflowNode node)
        Sets the root node of the WorkflowModel.
        Parameters:
        node - The root node of the WorkflowModel.
      • setEndNode

        void setEndNode​(WorkflowNode node)
        Sets the end node of the WorkflowModel.
        Parameters:
        node - The end node of the WorkflowModel.
      • getNode

        WorkflowNode getNode​(java.lang.String id)
        Returns the WorkflowNode with the given id
        Parameters:
        id - The ID of the WorkflowNode.
        Returns:
        The WorkflowNode or null if not found.