org.nuxeo.ecm.platform.routing.web

Class RoutingTaskActionsBean

java.lang.Object

org.nuxeo.ecm.platform.routing.web.RoutingTaskActionsBean

All Implemented Interfaces:

Serializable

@Scope(value=CONVERSATION)
 @Name(value="routingTaskActions")
public class RoutingTaskActionsBean
extends Object
implements Serializable

Task validators

Since:

5.6

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RoutingTaskActionsBean.TaskInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionContextProvider	actionContextProvider
protected org.nuxeo.ecm.platform.actions.ejb.ActionManager	actionService
protected String	button
static String	CACHE_ACTIONS_PER_TASK_TYPE_PROP_NAME Runtime property name, that makes it possible to cache actions available on a given task, depending on its type.
protected org.nuxeo.ecm.platform.contentview.seam.ContentViewActions	contentViewActions
protected Task	currentTask
protected org.nuxeo.ecm.core.api.CoreSession	documentManager
protected DocumentsListsManager	documentsListsManager
protected org.jboss.seam.faces.FacesMessages	facesMessages
protected Map<String,String>	messages
protected NavigationContext	navigationContext
static String	SUBJECT_PATTERN
protected Map<String,RoutingTaskActionsBean.TaskInfo>	tasksInfoCache

Constructor Summary

Constructors

Constructor and Description
RoutingTaskActionsBean()

Method Summary

Modifier and Type	Method and Description
boolean	canBeReassign()
String	delegateTask(RoutingTaskActionsBean.TaskInfo taskInfo)
String	endTask(Task task)
String	endTasks(String selectionListName, org.nuxeo.ecm.platform.actions.Action taskAction) Ends a task given a selection list name and an action
Task	getCurrentTask()
List<String>	getCurrentTaskTargetDocumentsIds() Added to avoid an error when opening a task created @before 5.8 see NXP-14047
Map<String,Serializable>	getFormVariables(Task task)
protected String	getTaskActionId(Task task, String buttonId) Helper to generate a unique action id for all task types
List<org.nuxeo.ecm.platform.actions.Action>	getTaskActions(String selectionListName) Returns actions for task document buttons defined in the workflow graph
List<org.nuxeo.ecm.platform.actions.Action>	getTaskActions(Task task)
Map<String,org.nuxeo.ecm.platform.actions.Action>	getTaskActionsMap(Task task)
List<org.nuxeo.ecm.platform.actions.Action>	getTaskButtons(Task task)
RoutingTaskActionsBean.TaskInfo	getTaskInfo(Task task, boolean getFormVariables)
String	getTaskLayout(Task task)
String	getWorkflowTitle(String instanceId)
protected boolean	isLayoutEmpty(String layoutName)
boolean	isRoutingTask(Task task)
String	navigateToTask(org.nuxeo.ecm.core.api.DocumentModel taskDoc)
String	navigateToTasksView()
void	OnTaskCompleted()
String	reassignTask(RoutingTaskActionsBean.TaskInfo taskInfo)
void	setCurrentTask(Task currentTask)
void	validateSubject(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Object value)
void	validateTaskDueDate(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Object value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBJECT_PATTERN

public static final String SUBJECT_PATTERN

See Also:

Constant Field Values

CACHE_ACTIONS_PER_TASK_TYPE_PROP_NAME

public static final String CACHE_ACTIONS_PER_TASK_TYPE_PROP_NAME

Runtime property name, that makes it possible to cache actions available on a given task, depending on its type.

This caching is global to all tasks in the platform, and will not work correctly if some tasks are filtering some actions depending on local variables, for instance.

Since:

5.7

See Also:

Constant Field Values

documentManager

@In(create=true,
    required=false)
protected transient org.nuxeo.ecm.core.api.CoreSession documentManager

navigationContext

@In(required=true,
    create=true)
protected NavigationContext navigationContext

facesMessages

@In(create=true,
    required=false)
protected org.jboss.seam.faces.FacesMessages facesMessages

messages

@In(create=true)
protected Map<String,String> messages

documentsListsManager

@In(create=true)
protected transient DocumentsListsManager documentsListsManager

actionContextProvider

@In(create=true,
    required=false)
protected transient ActionContextProvider actionContextProvider

contentViewActions

@In(create=true,
    required=false)
protected org.nuxeo.ecm.platform.contentview.seam.ContentViewActions contentViewActions

button

@RequestParameter(value="button")
protected String button

actionService

protected org.nuxeo.ecm.platform.actions.ejb.ActionManager actionService

tasksInfoCache

protected Map<String,RoutingTaskActionsBean.TaskInfo> tasksInfoCache

currentTask

protected Task currentTask

Constructor Detail

RoutingTaskActionsBean

public RoutingTaskActionsBean()

Method Detail

validateTaskDueDate

public void validateTaskDueDate(javax.faces.context.FacesContext context,
                                javax.faces.component.UIComponent component,
                                Object value)

validateSubject

public void validateSubject(javax.faces.context.FacesContext context,
                            javax.faces.component.UIComponent component,
                            Object value)

getTaskLayout

public String getTaskLayout(Task task)
                     throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getTaskButtons

public List<org.nuxeo.ecm.platform.actions.Action> getTaskButtons(Task task)
                                                           throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

endTask

public String endTask(Task task)
               throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getFormVariables

public Map<String,Serializable> getFormVariables(Task task)
                                          throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getTaskInfo

public RoutingTaskActionsBean.TaskInfo getTaskInfo(Task task,
                                                   boolean getFormVariables)
                                            throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

isRoutingTask

public boolean isRoutingTask(Task task)

Since:

5.6

getTaskActions

public List<org.nuxeo.ecm.platform.actions.Action> getTaskActions(Task task)
                                                           throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

isLayoutEmpty

protected boolean isLayoutEmpty(String layoutName)

getTaskActionId

protected String getTaskActionId(Task task,
                                 String buttonId)
                          throws org.nuxeo.ecm.core.api.ClientException

Helper to generate a unique action id for all task types

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.7

getTaskActionsMap

public Map<String,org.nuxeo.ecm.platform.actions.Action> getTaskActionsMap(Task task)
                                                                    throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

getTaskActions

public List<org.nuxeo.ecm.platform.actions.Action> getTaskActions(String selectionListName)
                                                           throws org.nuxeo.ecm.core.api.ClientException

Returns actions for task document buttons defined in the workflow graph

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

endTasks

public String endTasks(String selectionListName,
                       org.nuxeo.ecm.platform.actions.Action taskAction)
                throws org.nuxeo.ecm.core.api.ClientException

Ends a task given a selection list name and an action

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

OnTaskCompleted

@Observer(value={"workflowTaskCompleted","workflowTaskReassigned","workflowTaskDelegated"})
 @BypassInterceptors
public void OnTaskCompleted()

Since:

5.7

reassignTask

public String reassignTask(RoutingTaskActionsBean.TaskInfo taskInfo)

Since:

5.7.3

getWorkflowTitle

public String getWorkflowTitle(String instanceId)

Since:

5.7.3

delegateTask

public String delegateTask(RoutingTaskActionsBean.TaskInfo taskInfo)

Since:

5.8

navigateToTask

public String navigateToTask(org.nuxeo.ecm.core.api.DocumentModel taskDoc)

Since:

5.8

navigateToTasksView

public String navigateToTasksView()

Since:

5.8

getCurrentTask

public Task getCurrentTask()

Since:

5.8

setCurrentTask

public void setCurrentTask(Task currentTask)

Since:

5.8

getCurrentTaskTargetDocumentsIds

public List<String> getCurrentTaskTargetDocumentsIds()
                                              throws org.nuxeo.ecm.core.api.ClientException

Added to avoid an error when opening a task created @before 5.8 see NXP-14047

Returns:

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.9.3, 5.8.0-HF10

canBeReassign

public boolean canBeReassign()
                      throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.8 - Define if action reassign task can be displayed.