Package com.mendix.workflows

Interface Workflows

public interface Workflows

Provides an interface to the workflow component of the runtime server.

Method Summary

Modifier and Type	Method	Description
UserTask	getUserTask(IContext context, IMendixObject userTask)	Retrieves the user task object for a given user task context object.
Workflow	getWorkflow(IContext context, IMendixObject workflow)	Retrieves the workflow object.
Workflow	instantiate(IContext context, java.lang.String workflowName, IMendixObject workflowContext)	Instantiates new workflow.
void	lockWorkflowDefinition(IContext context, java.lang.String workflowName, boolean pauseAllWorkflows)	Locks the workflow definition for the given workflow name.
void	unlockWorkflowDefinition(IContext context, java.lang.String workflowName, boolean resumeAllPausedWorkflows)	Unlocks the workflow definition for the given workflow name.

Method Detail

instantiate

Workflow instantiate(IContext context,
                     java.lang.String workflowName,
                     IMendixObject workflowContext)

Instantiates new workflow.

Parameters:

context - the context

workflowName - name of the workflow

workflowContext - workflow parameter context

Returns:

the instantiated workflow

getWorkflow

Workflow getWorkflow(IContext context,
                     IMendixObject workflow)

Retrieves the workflow object.

Parameters:

context - the context

workflow - the workflow context object

Returns:

the workflow object

lockWorkflowDefinition

void lockWorkflowDefinition(IContext context,
                            java.lang.String workflowName,
                            boolean pauseAllWorkflows)

Locks the workflow definition for the given workflow name.

Parameters:

context - the context

workflowName - name of the workflow

pauseAllWorkflows - parameter for pausing the workflow instances of the given workflow's definition

Throws:

UserException - if the workflow definition has been already locked

unlockWorkflowDefinition

void unlockWorkflowDefinition(IContext context,
                              java.lang.String workflowName,
                              boolean resumeAllPausedWorkflows)

Unlocks the workflow definition for the given workflow name.

Parameters:

context - the context

workflowName - name of the workflow

resumeAllPausedWorkflows - parameter for resuming the workflow instances of the given workflow's definition

Throws:

UserException - if the workflow definition is not locked

getUserTask

UserTask getUserTask(IContext context,
                     IMendixObject userTask)

Retrieves the user task object for a given user task context object.

Parameters:

context - the context

userTask - the user task context object

Returns:

the user task object