Interface WorkflowModel

  • All Superinterfaces:
    HasMetaData

    @ProviderType
    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()
        Returns:
        the created workflow node
      • createNode

        WorkflowNode createNode​(java.lang.String title,
                                java.lang.String type,
                                java.lang.String description)
        Parameters:
        title - the title
        type - the type
        description - the description
        Returns:
        the created workflow node
      • setRootNode

        void setRootNode​(WorkflowNode node)
        Parameters:
        node - the workflow node
      • setEndNode

        void setEndNode​(WorkflowNode node)
        Parameters:
        node - the workflow node
      • 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.
      • createTransition

        WorkflowTransition createTransition()
        Returns:
        the created workflow transition
      • createTransition

        WorkflowTransition createTransition​(WorkflowNode from,
                                            WorkflowNode to,
                                            java.lang.String rule)
        Parameters:
        from - the workflow node to begin the transition with
        to - the workflow node to end the transition with
        rule - the rule
        Returns:
        the created workflow transition
      • getVariableTemplates

        java.util.Map<java.lang.String,​VariableTemplate> getVariableTemplates()
        Returns:
        a Map with keys as variables' names and values as VariableTemplates .
      • createVariableTemplate

        VariableTemplate createVariableTemplate​(java.lang.String name,
                                                java.lang.String dataType)
        Parameters:
        name - the name of the variable
        dataType - the type of the variable in java fully qualified class name format
        Returns:
        the created variable template