Package com.mendix.workflows

Interface WorkflowDefinition

public interface WorkflowDefinition
Provides an interface for working with workflow definitions.

  • Method Summary

    Modifier and Type
    Method
    Description
    Workflow
    instantiate(IContext context, IMendixObject workflowContext)
    Instantiates a new workflow and returns the object representing it.
    void
    lock(IContext context, boolean pauseAllWorkflows)
    Locks the workflow definition for the specified workflow name.
    void
    unlock(IContext context, boolean resumeAllPausedWorkflows)
    Unlocks the workflow definition for the specified workflow name.

  • Method Details

    • instantiate

      Workflow instantiate(IContext context, IMendixObject workflowContext)
      Instantiates a new workflow and returns the object representing it.
      Parameters:
      context - the context in which to create the workflow
      workflowContext - the context parameter object to associate with the workflow
      Returns:
      the instantiated workflow

    • lock

      void lock(IContext context, boolean pauseAllWorkflows)
      Locks the workflow definition for the specified workflow name.
      Parameters:
      context - the context in which to lock the definition
      pauseAllWorkflows - indicates whether to pause all workflow instances with the same definition
      Throws:
      UserException - if the workflow definition has already been locked

    • unlock

      void unlock(IContext context, boolean resumeAllPausedWorkflows)
      Unlocks the workflow definition for the specified workflow name.
      Parameters:
      context - the context in which to unlock the definition
      resumeAllPausedWorkflows - indicates whether to resume all paused workflow instances with the same definition
      Throws:
      UserException - if the workflow definition is not locked