org.nuxeo.ecm.platform.jbpm.web
Interface JbpmActions

All Superinterfaces:

Serializable

All Known Implementing Classes:

JbpmActionsBean

public interface JbpmActions
extends Serializable

Author:

Anahide Tchertchian

Method Summary

String	abandonCurrentProcess()
String	addNewVirtualTask()
String	createProcessInstance(NuxeoPrincipal principal, String pd, DocumentModel dm, String endLifeCycle)
List<String>	getAllowedStateTransitions(DocumentRef ref) Returns the list of allowed life cycle state transitions for given document.
boolean	getCanCreateProcess()
boolean	getCanEndTask(TaskInstance taskInstance)
boolean	getCanManageParticipants()
boolean	getCanManageProcess()
ProcessInstance	getCurrentProcess()
String	getCurrentProcessInitiator()
List<TaskInstance>	getCurrentTasks(String... taskNames)
ArrayList<VirtualTaskInstance>	getCurrentVirtualTasks()
VirtualTaskInstance	getNewVirtualTask()
boolean	getShowAddVirtualTaskForm()
String	getUserComment()
boolean	hasProcessDefinitions(String documentType) Returns true if given document type has process definitions attached to it.
boolean	isProcessStarted(String startTaskName)
String	moveDownVirtualTask(int index)
String	moveUpVirtualTask(int index)
String	rejectTask(TaskInstance taskInstance, String transition)
String	removeVirtualTask(int index)
void	resetCurrentData()
void	setUserComment(String comment)
String	startProcess(String startTaskName)
void	toggleShowAddVirtualTaskForm(ActionEvent event)
String	validateTask(TaskInstance taskInstance, String transition)
void	validateTaskDueDate(FacesContext context, UIComponent component, Object value)

Method Detail

getCanCreateProcess

boolean getCanCreateProcess()
                            throws ClientException

Throws:

ClientException

getCanManageProcess

boolean getCanManageProcess()
                            throws ClientException

Throws:

ClientException

getCanManageParticipants

boolean getCanManageParticipants()
                                 throws ClientException

Throws:

ClientException

getCanEndTask

boolean getCanEndTask(TaskInstance taskInstance)
                      throws ClientException

Throws:

ClientException

createProcessInstance

String createProcessInstance(NuxeoPrincipal principal,
                             String pd,
                             DocumentModel dm,
                             String endLifeCycle)
                             throws ClientException

Throws:

ClientException

getCurrentProcess

ProcessInstance getCurrentProcess()
                                  throws ClientException

Throws:

ClientException

getCurrentProcessInitiator

String getCurrentProcessInitiator()
                                  throws ClientException

Throws:

ClientException

getCurrentTasks

List<TaskInstance> getCurrentTasks(String... taskNames)
                                   throws ClientException

Throws:

ClientException

getCurrentVirtualTasks

ArrayList<VirtualTaskInstance> getCurrentVirtualTasks()
                                                      throws ClientException

Throws:

ClientException

getShowAddVirtualTaskForm

boolean getShowAddVirtualTaskForm()
                                  throws ClientException

Throws:

ClientException

toggleShowAddVirtualTaskForm

void toggleShowAddVirtualTaskForm(ActionEvent event)
                                  throws ClientException

Throws:

ClientException

getNewVirtualTask

VirtualTaskInstance getNewVirtualTask()

addNewVirtualTask

String addNewVirtualTask()
                         throws ClientException

Throws:

ClientException

removeVirtualTask

String removeVirtualTask(int index)
                         throws ClientException

Throws:

ClientException

moveUpVirtualTask

String moveUpVirtualTask(int index)
                         throws ClientException

Throws:

ClientException

moveDownVirtualTask

String moveDownVirtualTask(int index)
                           throws ClientException

Throws:

ClientException

getAllowedStateTransitions

List<String> getAllowedStateTransitions(DocumentRef ref)
                                        throws ClientException

Returns the list of allowed life cycle state transitions for given document.

Throws:

ClientException

getUserComment

String getUserComment()

setUserComment

void setUserComment(String comment)

validateTaskDueDate

void validateTaskDueDate(FacesContext context,
                         UIComponent component,
                         Object value)

isProcessStarted

boolean isProcessStarted(String startTaskName)
                         throws ClientException

Throws:

ClientException

startProcess

String startProcess(String startTaskName)
                    throws ClientException

Throws:

ClientException

validateTask

String validateTask(TaskInstance taskInstance,
                    String transition)
                    throws ClientException

Throws:

ClientException

rejectTask

String rejectTask(TaskInstance taskInstance,
                  String transition)
                  throws ClientException

Throws:

ClientException

abandonCurrentProcess

String abandonCurrentProcess()
                             throws ClientException

Throws:

ClientException

resetCurrentData

void resetCurrentData()

hasProcessDefinitions

boolean hasProcessDefinitions(String documentType)

Returns true if given document type has process definitions attached to it.

Parameters:

documentType - the document type name

Since:

5.4.3