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
static String	ROUTE_DOCUMENT_REF
static String	SOURCE_DOC_NAME

Constructor Summary

Constructors

Constructor and Description
DocumentRoutingActionsBean()

Method Summary

Methods

Modifier and Type	Method and Description
String	cancelRoute() Cancels the first workflow found on the current document
boolean	canLockRoute()
boolean	canUnlockRoute()
SelectDataModel	computeSelectDataModelRelatedRouteElements()
SelectDataModel	computeSelectDataModelRouteElements()
SelectDataModel	computeSelectDataModelRouteElements(DocumentModel relatedRouteDocumentModel)
String	createRouteElement(String typeName)
boolean	currentRouteModelIsDraft()
String	editStep()
boolean	getCanDuplicateRouteInstance()
DocumentModel	getChildWithPosition(DocumentModel docRouteElement, String pos)
List<Task>	getCurrentRouteAllTasks()
List<Task>	getCurrentRouteCurrentUserTasks()
Map<String,Serializable>	getCurrentRouteLockDetails()
String	getCurrentWorkflowInitiator()
Converter	getDocumentModelConverter()
DocumentRoutingService	getDocumentRoutingService()
String	getDocWithAttachedRouteId()
List<DocumentModel>	getFilteredRouteModels()
String	getHiddenDocOrder()
String	getHiddenSourceDocId()
List<DocumentModel>	getOrderedChildren(String docRouteElementId, String type)
String	getPositionForChild(DocumentModel docRouteElement, DocumentModel docChild)
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.
DocumentModel	getRouteInstanceFor(Task task)
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(DocumentModel stepDoc) Returns true if the givenDoc is an routeElement that can be edited
boolean	isEditableStep(DocumentModel stepDoc) Returns true if the givenDoc is a step that can be edited
boolean	isEmptyFork(DocumentModel forkDoc)
boolean	isRoutable()
boolean	isRouteGraph(DocumentRoute route) Checks if a given route is a Graph.
boolean	isStep(DocumentModel doc)
String	lockCurrentRoute()
String	moveRouteElement(String direction) Moves the step in the parent container in the specified direction.
String	removeStep()
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

equals, 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

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 ClientException

Throws:

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

cancelRoute

public String cancelRoute()
                   throws ClientException

Cancels the first workflow found on the current document

Throws:

ClientException

saveRouteAsNewInstance

public void saveRouteAsNewInstance()

saveSelectedRouteAsNewInstance

public void saveSelectedRouteAsNewInstance()

getCanDuplicateRouteInstance

public boolean getCanDuplicateRouteInstance()

validateRouteModel

public String validateRouteModel()
                          throws ClientException

Throws:

ClientException

computeSelectDataModelRouteElements

@Factory(value="routeElementsSelectModel",
         scope=EVENT)
public SelectDataModel computeSelectDataModelRouteElements()
                                                    throws ClientException

Throws:

ClientException

computeSelectDataModelRelatedRouteElements

@Factory(value="relatedRouteElementsSelectModel",
         scope=EVENT)
public SelectDataModel computeSelectDataModelRelatedRouteElements()
                                                           throws ClientException

Throws:

ClientException

computeSelectDataModelRouteElements

public SelectDataModel computeSelectDataModelRouteElements(DocumentModel relatedRouteDocumentModel)
                                                    throws ClientException

Throws:

ClientException

hasRelatedRoute

public boolean hasRelatedRoute()

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

startRouteRelatedToCurrentDocument

public String startRouteRelatedToCurrentDocument()
                                          throws ClientException

Throws:

ClientException

routeRelatedToCurrentDocumentIsRunning

public boolean routeRelatedToCurrentDocumentIsRunning()
                                               throws ClientException

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

Throws:

ClientException

getTypeDescription

public String getTypeDescription(DocumentRouteTableElement localizable)

getDocumentModelConverter

public Converter getDocumentModelConverter()

isStep

public boolean isStep(DocumentModel doc)

currentRouteModelIsDraft

public boolean currentRouteModelIsDraft()

removeStep

public String removeStep()
                  throws ClientException

Throws:

ClientException

isEditableStep

public boolean isEditableStep(DocumentModel stepDoc)
                       throws ClientException

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

Throws:

ClientException

isEditableRouteElement

public boolean isEditableRouteElement(DocumentModel stepDoc)
                               throws ClientException

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

Throws:

ClientException

isCurrentRouteLockedByCurrentUser

@Factory(value="currentRouteLockedByCurrentUser",
         scope=EVENT)
public boolean isCurrentRouteLockedByCurrentUser()
                                          throws ClientException

Throws:

ClientException

isCurrentRouteLocked

public boolean isCurrentRouteLocked()
                             throws ClientException

Throws:

ClientException

canUnlockRoute

public boolean canUnlockRoute()
                       throws ClientException

Throws:

ClientException

canLockRoute

public boolean canLockRoute()
                     throws ClientException

Throws:

ClientException

getCurrentRouteLockDetails

public Map<String,Serializable> getCurrentRouteLockDetails()
                                                    throws ClientException

Throws:

ClientException

lockCurrentRoute

public String lockCurrentRoute()
                        throws ClientException

Throws:

ClientException

unlockCurrentRoute

public String unlockCurrentRoute()
                          throws ClientException

Throws:

ClientException

isEmptyFork

public boolean isEmptyFork(DocumentModel forkDoc)
                    throws ClientException

Throws:

ClientException

editStep

public String editStep()
                throws ClientException

Throws:

ClientException

updateRouteElement

public String updateRouteElement()
                          throws ClientException

Throws:

ClientException

goBackToRoute

public String goBackToRoute()
                     throws ClientException

Throws:

ClientException

createRouteElement

public String createRouteElement(String typeName)
                          throws ClientException

Throws:

ClientException

moveRouteElement

public String moveRouteElement(String direction)
                        throws ClientException

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 availabe , so no check is done

Throws:

ClientException

saveRouteElement

public String saveRouteElement()
                        throws ClientException

Throws:

ClientException

getOrderedChildren

public List<DocumentModel> getOrderedChildren(String docRouteElementId,
                                     String type)
                                       throws ClientException

Throws:

ClientException

getChildWithPosition

public DocumentModel getChildWithPosition(DocumentModel docRouteElement,
                                 String pos)
                                   throws ClientException

Throws:

ClientException

getPositionForChild

public String getPositionForChild(DocumentModel docRouteElement,
                         DocumentModel docChild)
                           throws ClientException

Throws:

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","workflowTaskCompleted","workflowProcessCanceled","workflowTaskRejected"},
          create=false)
public void resetCache()

getRouteModel

public DocumentModel getRouteModel(String routeId)
                            throws ClientException

Throws:

ClientException

Since:

5.6

getRouteInstanceFor

public DocumentModel getRouteInstanceFor(Task task)
                                  throws ClientException

Throws:

ClientException

Since:

5.6

getFilteredRouteModels

public List<DocumentModel> getFilteredRouteModels()
                                           throws ClientException

Throws:

ClientException

Since:

5.6

getCurrentRouteAllTasks

public List<Task> getCurrentRouteAllTasks()
                                   throws ClientException

Throws:

ClientException

Since:

5.6

getCurrentRouteCurrentUserTasks

public List<Task> getCurrentRouteCurrentUserTasks()
                                           throws ClientException

Throws:

ClientException

Since:

5.6

getCurrentWorkflowInitiator

public String getCurrentWorkflowInitiator()
                                   throws ClientException

Throws:

ClientException

Since:

5.6

isCurrentRouteGraph

public boolean isCurrentRouteGraph()
                            throws ClientException

since 5.7

Throws:

ClientException

isRouteGraph

public boolean isRouteGraph(DocumentRoute route)
                     throws ClientException

Checks if a given route is a Graph.

Throws:

ClientException

Since:

5.7.2