org.jahia.services.workflow

Interface WorkflowProvider

All Known Implementing Classes:

JBPM6WorkflowProvider

public interface WorkflowProvider

BPM engine provider.

Since:

JAHIA 6.5

Author:

rincevent

Method Summary

Modifier and Type	Method and Description
void	abortProcess(String processId)
void	addComment(String processId, String comment, String user)
void	assignTask(String taskId, JahiaUser user)
void	completeTask(String taskId, JahiaUser jahiaUser, String outcome, Map<String,Object> args)
void	deleteProcess(String processId)
List<Workflow>	getActiveWorkflowsInformations(List<String> processIds, Locale uiLocale)
Set<WorkflowAction>	getAvailableActions(String processId, Locale uiLocale) Returns the next possible connections for a given process (usually only for User tasks).
List<WorkflowDefinition>	getAvailableWorkflows(Locale uiLocale)
List<HistoryWorkflow>	getHistoryWorkflows(List<String> processIds, Locale uiLocale) Returns a list of process instance history records for the specified process IDs.
List<HistoryWorkflow>	getHistoryWorkflowsForNode(String nodeId, Locale uiLocale)
List<HistoryWorkflow>	getHistoryWorkflowsForPath(String path, Locale uiLocale)
List<HistoryWorkflowTask>	getHistoryWorkflowTasks(String processId, Locale uiLocale) Returns a list of history records for workflow tasks.
String	getKey()
List<WorkflowTask>	getTasksForUser(JahiaUser user, Locale uiLocale)
Workflow	getWorkflow(String processId, Locale uiLocale)
WorkflowDefinition	getWorkflowDefinitionByKey(String key, Locale uiLocale)
List<Workflow>	getWorkflowsForDefinition(String definition, Locale uiLocale)
List<Workflow>	getWorkflowsForUser(JahiaUser user, Locale uiLocale)
WorkflowTask	getWorkflowTask(String taskId, Locale uiLocale)
String	startProcess(String processKey, Map<String,Object> args) Start a process instance previously registered

Method Detail

getKey

String getKey()

getAvailableWorkflows

List<WorkflowDefinition> getAvailableWorkflows(Locale uiLocale)

getWorkflowDefinitionByKey

WorkflowDefinition getWorkflowDefinitionByKey(String key,
                                              Locale uiLocale)

getActiveWorkflowsInformations

List<Workflow> getActiveWorkflowsInformations(List<String> processIds,
                                              Locale uiLocale)

startProcess

String startProcess(String processKey,
                    Map<String,Object> args)

Start a process instance previously registered

Parameters:

processKey -

args -

Returns:

the process instance identifier

abortProcess

void abortProcess(String processId)

getWorkflow

Workflow getWorkflow(String processId,
                     Locale uiLocale)

getAvailableActions

Set<WorkflowAction> getAvailableActions(String processId,
                                        Locale uiLocale)

Returns the next possible connections for a given process (usually only for User tasks).

Parameters:

processId -

uiLocale - current UI display locale

Returns:

getTasksForUser

List<WorkflowTask> getTasksForUser(JahiaUser user,
                                   Locale uiLocale)

getWorkflowsForDefinition

List<Workflow> getWorkflowsForDefinition(String definition,
                                         Locale uiLocale)

getWorkflowsForUser

List<Workflow> getWorkflowsForUser(JahiaUser user,
                                   Locale uiLocale)

assignTask

void assignTask(String taskId,
                JahiaUser user)

completeTask

void completeTask(String taskId,
                  JahiaUser jahiaUser,
                  String outcome,
                  Map<String,Object> args)

addComment

void addComment(String processId,
                String comment,
                String user)

getWorkflowTask

WorkflowTask getWorkflowTask(String taskId,
                             Locale uiLocale)

getHistoryWorkflowsForNode

List<HistoryWorkflow> getHistoryWorkflowsForNode(String nodeId,
                                                 Locale uiLocale)

getHistoryWorkflowsForPath

List<HistoryWorkflow> getHistoryWorkflowsForPath(String path,
                                                 Locale uiLocale)

getHistoryWorkflows

List<HistoryWorkflow> getHistoryWorkflows(List<String> processIds,
                                          Locale uiLocale)

Returns a list of process instance history records for the specified process IDs. This method also returns "active" (i.e. not completed) workflow process instance.

Parameters:

processIds - list of process IDs to retrieve history records for

uiLocale - the UI locale

Returns:

a list of process instance history records for the specified process IDs

getHistoryWorkflowTasks

List<HistoryWorkflowTask> getHistoryWorkflowTasks(String processId,
                                                  Locale uiLocale)

Returns a list of history records for workflow tasks. This method also returns not completed tasks.

Parameters:

processId - the process instance ID

uiLocale - the UI locale

Returns:

a list of history records for workflow tasks

deleteProcess

void deleteProcess(String processId)