org.nuxeo.ecm.platform.routing.web

Class DocumentRoutingActionsBean

java.lang.Object

org.nuxeo.ecm.platform.routing.web.DocumentRoutingActionsBean

All Implemented Interfaces:

Serializable

@Scope(value=CONVERSATION)
 @Name(value="routingActions")
 @Install(precedence=10)
public class DocumentRoutingActionsBean
extends Object
implements Serializable

Actions for current document route

Author:

Mariana Cedica

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.nuxeo.ecm.core.api.NuxeoPrincipal	currentUser
protected org.nuxeo.ecm.core.api.CoreSession	documentManager
protected DocumentsListsManager	documentsListsManager
protected String	docWithAttachedRouteId
protected EventManager	eventManager
protected org.jboss.seam.faces.FacesMessages	facesMessages
protected String	hiddenDocOrder
protected String	hiddenSourceDocId
protected LockActions	lockActions
protected NavigationContext	navigationContext
protected RelatedRouteActionBean	relatedRouteAction
protected String	relatedRouteModelDocumentId
protected List<org.nuxeo.ecm.core.api.DocumentModel>	relatedRoutes
protected ResourcesAccessor	resourcesAccessor
static String	ROUTE_DOCUMENT_REF
static String	SOURCE_DOC_NAME
protected String	stepId
protected org.nuxeo.ecm.platform.types.TypeManager	typeManager
protected TypesTool	typesTool
protected WebActions	webActions

Constructor Summary

Constructors

Constructor and Description
DocumentRoutingActionsBean()

Method Summary

Modifier and Type	Method and Description
String	cancelRoute() Cancels the first workflow found on the current document
boolean	canLockRoute()
boolean	canUnlockRoute()
protected List<DocumentRouteTableElement>	computeRelatedRouteElements() Deprecated. since 5.9.2 - Use only routes of type 'graph'
protected List<DocumentRouteTableElement>	computeRouteElements() Deprecated. since 5.9.2 - Use only routes of type 'graph'
String	createRouteElement(String typeName) Deprecated. since 5.9.2 - Use only routes of type 'graph'
boolean	currentRouteModelIsDraft()
String	editStep()
boolean	getCanDuplicateRouteInstance()
org.nuxeo.ecm.core.api.DocumentModel	getChildWithPosition(org.nuxeo.ecm.core.api.DocumentModel docRouteElement, String pos) Deprecated.
List<Task>	getCurrentRouteAllTasks()
List<Task>	getCurrentRouteCurrentUserTasks()
Map<String,Serializable>	getCurrentRouteLockDetails()
String	getCurrentWorkflowInitiator()
javax.faces.convert.Converter	getDocumentModelConverter()
DocumentRoutingService	getDocumentRoutingService()
String	getDocWithAttachedRouteId()
protected List<DocumentRouteTableElement>	getElements(DocumentRoute currentRoute) Deprecated. since 5.9.2 - Use only routes of type 'graph'
List<org.nuxeo.ecm.core.api.DocumentModel>	getFilteredRouteModels()
String	getHiddenDocOrder()
String	getHiddenSourceDocId()
List<org.nuxeo.ecm.core.api.DocumentModel>	getOrderedChildren(String docRouteElementId, String type) Deprecated.
String	getPositionForChild(org.nuxeo.ecm.core.api.DocumentModel docRouteElement, org.nuxeo.ecm.core.api.DocumentModel docChild) Deprecated.
DocumentRoute	getRelatedRoute() Gets the first related route.
String	getRelatedRouteModelDocumentId()
List<DocumentRoute>	getRelatedRoutes() Gets the list of routes related to the current document, by querying the routing service.
org.nuxeo.ecm.core.api.DocumentModel	getRouteInstanceFor(Task task)
org.nuxeo.ecm.core.api.DocumentModel	getRouteModel(String routeId)
String	getTypeDescription(DocumentRouteTableElement localizable)
String	goBackToRoute()
boolean	hasRelatedRoute() Check if the related route to this case is started (ready or running) or no
boolean	isCurrentRouteGraph() since 5.7
boolean	isCurrentRouteLocked()
boolean	isCurrentRouteLockedByCurrentUser()
boolean	isEditableRouteElement(org.nuxeo.ecm.core.api.DocumentModel stepDoc) Deprecated. since 5.9.2 - Use only routes of type 'graph'
boolean	isEditableStep(org.nuxeo.ecm.core.api.DocumentModel stepDoc) Deprecated. since 5.9.2 - Use only routes of type 'graph'
boolean	isEmptyFork(org.nuxeo.ecm.core.api.DocumentModel forkDoc)
boolean	isRoutable()
boolean	isRouteGraph(DocumentRoute route) Checks if a given route is a Graph.
boolean	isStep(org.nuxeo.ecm.core.api.DocumentModel doc)
String	lockCurrentRoute()
protected String	lockRoute(DocumentRoute docRouteElement)
String	moveRouteElement(String direction) Deprecated. since 5.9.2 - Use only routes of type 'graph'
protected void	queryForRelatedRoutes()
String	removeStep() Deprecated.
void	resetCache()
void	resetRelatedRouteDocumentId()
boolean	routeRelatedToCurrentDocumentIsRunning() returns true if the routeStarted on the current Document is editable (is Ready )
void	saveRouteAsNewInstance()
String	saveRouteElement()
void	saveSelectedRouteAsNewInstance()
void	setDocWithAttachedRouteId(String docWithAttachedRouteId)
void	setHiddenDocOrder(String hiddenDocOrder)
void	setHiddenSourceDocId(String hiddenSourceDocId)
void	setRelatedRouteModelDocumentId(String relatedRouteModelDocumentId)
String	startRoute()
String	startRouteRelatedToCurrentDocument()
String	unlockCurrentRoute()
String	updateRouteElement()
String	validateRouteModel()

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_DOC_NAME

public static final String SOURCE_DOC_NAME

See Also:

Constant Field Values

ROUTE_DOCUMENT_REF

public static final String ROUTE_DOCUMENT_REF

See Also:

Constant Field Values

navigationContext

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

documentManager

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

facesMessages

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

webActions

@In(create=true)
protected WebActions webActions

lockActions

@In(create=true)
protected LockActions lockActions

typesTool

@In(create=true,
    required=false)
protected TypesTool typesTool

resourcesAccessor

@In(create=true)
protected ResourcesAccessor resourcesAccessor

typeManager

@In(create=true)
protected org.nuxeo.ecm.platform.types.TypeManager typeManager

eventManager

@In(create=true)
protected EventManager eventManager

currentUser

@In(required=true,
    create=true)
protected org.nuxeo.ecm.core.api.NuxeoPrincipal currentUser

relatedRoutes

@In(create=true)
protected List<org.nuxeo.ecm.core.api.DocumentModel> relatedRoutes

relatedRouteAction

@In(create=true)
protected RelatedRouteActionBean relatedRouteAction

documentsListsManager

@In(create=true)
protected DocumentsListsManager documentsListsManager

stepId

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

relatedRouteModelDocumentId

protected String relatedRouteModelDocumentId

docWithAttachedRouteId

protected String docWithAttachedRouteId

hiddenSourceDocId

protected String hiddenSourceDocId

hiddenDocOrder

protected String hiddenDocOrder

Constructor Detail

DocumentRoutingActionsBean

public DocumentRoutingActionsBean()

Method Detail

getDocumentRoutingService

public DocumentRoutingService getDocumentRoutingService()

resetRelatedRouteDocumentId

@Observer(value={"documentChanged","documentSelectionChanged"})
public void resetRelatedRouteDocumentId()

isRoutable

public boolean isRoutable()

startRoute

public String startRoute()
                  throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getRelatedRoute

public DocumentRoute getRelatedRoute()

Gets the first related route.

When called on an actual route or route element, the route is returned.

When called on a regular document, the routing service is queried to get the routes which have the current document attached.

When dealing with a regular document, this is DEPRECATED as several graph routes may be related to the current document (for instance in the case of sub-workflows). Use getRelatedRoutes() instead.

getRelatedRoutes

public List<DocumentRoute> getRelatedRoutes()

Gets the list of routes related to the current document, by querying the routing service.

Returns:

the list of routes (may be empty)

Since:

5.7.2

queryForRelatedRoutes

protected void queryForRelatedRoutes()

cancelRoute

public String cancelRoute()
                   throws org.nuxeo.ecm.core.api.ClientException

Cancels the first workflow found on the current document

Throws:

org.nuxeo.ecm.core.api.ClientException

saveRouteAsNewInstance

public void saveRouteAsNewInstance()

saveSelectedRouteAsNewInstance

public void saveSelectedRouteAsNewInstance()

getCanDuplicateRouteInstance

public boolean getCanDuplicateRouteInstance()

validateRouteModel

public String validateRouteModel()
                          throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

computeRouteElements

@Deprecated
protected List<DocumentRouteTableElement> computeRouteElements()
                                                                    throws org.nuxeo.ecm.core.api.ClientException

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Throws:

org.nuxeo.ecm.core.api.ClientException

computeRelatedRouteElements

@Deprecated
protected List<DocumentRouteTableElement> computeRelatedRouteElements()
                                                                           throws org.nuxeo.ecm.core.api.ClientException

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Throws:

org.nuxeo.ecm.core.api.ClientException

getElements

@Deprecated
protected List<DocumentRouteTableElement> getElements(DocumentRoute currentRoute)

Deprecated. since 5.9.2 - Use only routes of type 'graph'

hasRelatedRoute

public boolean hasRelatedRoute()

Check if the related route to this case is started (ready or running) or no

startRouteRelatedToCurrentDocument

public String startRouteRelatedToCurrentDocument()
                                          throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

routeRelatedToCurrentDocumentIsRunning

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

returns true if the routeStarted on the current Document is editable (is Ready )

Throws:

org.nuxeo.ecm.core.api.ClientException

getTypeDescription

public String getTypeDescription(DocumentRouteTableElement localizable)

getDocumentModelConverter

public javax.faces.convert.Converter getDocumentModelConverter()

isStep

public boolean isStep(org.nuxeo.ecm.core.api.DocumentModel doc)

currentRouteModelIsDraft

public boolean currentRouteModelIsDraft()

removeStep

@Deprecated
public String removeStep()
                              throws org.nuxeo.ecm.core.api.ClientException

Deprecated.

Throws:

org.nuxeo.ecm.core.api.ClientException

isEditableStep

@Deprecated
public boolean isEditableStep(org.nuxeo.ecm.core.api.DocumentModel stepDoc)
                                   throws org.nuxeo.ecm.core.api.ClientException

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Returns true if the givenDoc is a step that can be edited

Throws:

org.nuxeo.ecm.core.api.ClientException

isEditableRouteElement

@Deprecated
public boolean isEditableRouteElement(org.nuxeo.ecm.core.api.DocumentModel stepDoc)
                                           throws org.nuxeo.ecm.core.api.ClientException

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Returns true if the givenDoc is an routeElement that can be edited

Throws:

org.nuxeo.ecm.core.api.ClientException

isCurrentRouteLockedByCurrentUser

@Factory(value="currentRouteLockedByCurrentUser",
         scope=EVENT)
public boolean isCurrentRouteLockedByCurrentUser()
                                                                                                                  throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

isCurrentRouteLocked

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

Throws:

org.nuxeo.ecm.core.api.ClientException

canUnlockRoute

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

Throws:

org.nuxeo.ecm.core.api.ClientException

canLockRoute

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

Throws:

org.nuxeo.ecm.core.api.ClientException

getCurrentRouteLockDetails

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

Throws:

org.nuxeo.ecm.core.api.ClientException

lockCurrentRoute

public String lockCurrentRoute()
                        throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

lockRoute

protected String lockRoute(DocumentRoute docRouteElement)
                    throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

unlockCurrentRoute

public String unlockCurrentRoute()
                          throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

isEmptyFork

public boolean isEmptyFork(org.nuxeo.ecm.core.api.DocumentModel forkDoc)
                    throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

editStep

public String editStep()
                throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

updateRouteElement

public String updateRouteElement()
                          throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

goBackToRoute

public String goBackToRoute()
                     throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

createRouteElement

@Deprecated
public String createRouteElement(String typeName)
                                      throws org.nuxeo.ecm.core.api.ClientException

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Throws:

org.nuxeo.ecm.core.api.ClientException

moveRouteElement

@Deprecated
public String moveRouteElement(String direction)
                                    throws org.nuxeo.ecm.core.api.ClientException

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Moves the step in the parent container in the specified direction. If the step is in a parallel container, it can't be moved. A step can't be moved before a step already done or running. Assumed that the route is already locked to have this action available, so no check is done.

Throws:

org.nuxeo.ecm.core.api.ClientException

saveRouteElement

public String saveRouteElement()
                        throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getOrderedChildren

@Deprecated
public List<org.nuxeo.ecm.core.api.DocumentModel> getOrderedChildren(String docRouteElementId,
                                                                                 String type)
                                                                          throws org.nuxeo.ecm.core.api.ClientException

Deprecated.

Throws:

org.nuxeo.ecm.core.api.ClientException

getChildWithPosition

@Deprecated
public org.nuxeo.ecm.core.api.DocumentModel getChildWithPosition(org.nuxeo.ecm.core.api.DocumentModel docRouteElement,
                                                                             String pos)
                                                                      throws org.nuxeo.ecm.core.api.ClientException

Deprecated.

Throws:

org.nuxeo.ecm.core.api.ClientException

getPositionForChild

@Deprecated
public String getPositionForChild(org.nuxeo.ecm.core.api.DocumentModel docRouteElement,
                                              org.nuxeo.ecm.core.api.DocumentModel docChild)
                                       throws org.nuxeo.ecm.core.api.ClientException

Deprecated.

Throws:

org.nuxeo.ecm.core.api.ClientException

getHiddenSourceDocId

public String getHiddenSourceDocId()

setHiddenSourceDocId

public void setHiddenSourceDocId(String hiddenSourceDocId)

getHiddenDocOrder

public String getHiddenDocOrder()

setHiddenDocOrder

public void setHiddenDocOrder(String hiddenDocOrder)

getRelatedRouteModelDocumentId

public String getRelatedRouteModelDocumentId()

setRelatedRouteModelDocumentId

public void setRelatedRouteModelDocumentId(String relatedRouteModelDocumentId)

getDocWithAttachedRouteId

public String getDocWithAttachedRouteId()

setDocWithAttachedRouteId

public void setDocWithAttachedRouteId(String docWithAttachedRouteId)

resetCache

@Observer(value={"workflowProcessEnded","workflowProcessCanceled"},
          create=false)
public void resetCache()

getRouteModel

public org.nuxeo.ecm.core.api.DocumentModel getRouteModel(String routeId)
                                                   throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

getRouteInstanceFor

public org.nuxeo.ecm.core.api.DocumentModel getRouteInstanceFor(Task task)
                                                         throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

getFilteredRouteModels

public List<org.nuxeo.ecm.core.api.DocumentModel> getFilteredRouteModels()
                                                                  throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

getCurrentRouteAllTasks

public List<Task> getCurrentRouteAllTasks()
                                   throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

getCurrentRouteCurrentUserTasks

public List<Task> getCurrentRouteCurrentUserTasks()
                                           throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

getCurrentWorkflowInitiator

public String getCurrentWorkflowInitiator()
                                   throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

isCurrentRouteGraph

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

since 5.7

Throws:

org.nuxeo.ecm.core.api.ClientException

isRouteGraph

public boolean isRouteGraph(DocumentRoute route)
                     throws org.nuxeo.ecm.core.api.ClientException

Checks if a given route is a Graph.

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.7.2