Uses of Interface
org.nuxeo.ecm.platform.routing.api.DocumentRoute

Packages that use DocumentRoute

Package	Description
org.nuxeo.ecm.platform.routing.api	Provides the interfaces necessary to create and manipulate DocumentRoute.
org.nuxeo.ecm.platform.routing.core.api	Provides internal services to the DocumentRoutingService
org.nuxeo.ecm.platform.routing.core.impl	Provides implementation for the api package.
org.nuxeo.ecm.platform.routing.web	Provides the seam component used in the web UI.

Uses of DocumentRoute in org.nuxeo.ecm.platform.routing.api

Methods in org.nuxeo.ecm.platform.routing.api that return DocumentRoute

Modifier and Type	Method and Description
DocumentRoute	DocumentRoutingService.createNewInstance(DocumentRoute model, List<String> documentIds, CoreSession session) Deprecated. since 5.6, use other APIs
DocumentRoute	DocumentRoutingService.createNewInstance(DocumentRoute model, List<String> documentIds, CoreSession session, boolean startInstance) Create a new DocumentRoute instance from this DocumentRoute model.
DocumentRoute	DocumentRoutingService.createNewInstance(DocumentRoute model, String documentId, CoreSession session) Deprecated. since 5.6, use other APIs
DocumentRoute	DocumentRoutingService.createNewInstance(DocumentRoute model, String documentId, CoreSession session, boolean startInstance) Deprecated. since 5.6, use other APIs
DocumentRoute	DocumentRouteElement.getDocumentRoute(CoreSession session) Return the DocumentRoute this element is part of.
DocumentRoute	DocumentRoutingService.getRouteModelWithId(CoreSession session, String id) Returns the route model with the given id
DocumentRoute	DocumentRoutingService.importRouteModel(URL templateResource, boolean overwrite, CoreSession session) Creates a route model in the root models folder defined by the current persister.
DocumentRoute	DocumentRoutingService.saveRouteAsNewModel(DocumentRoute route, CoreSession session) Save a route instance as a new model of route.
DocumentRoute	DocumentRoutingService.unlockDocumentRouteUnrestrictedSession(DocumentRoute routeModel, CoreSession userSession) Unlock the given DocumentRoute model under unrestricted session.
DocumentRoute	DocumentRoutingService.validateRouteModel(DocumentRoute routeModel, CoreSession session) Validates the given DocumentRoute model by changing its lifecycle state and setting it and all its children in ReadOnly.

Methods in org.nuxeo.ecm.platform.routing.api that return types with arguments of type DocumentRoute

Modifier and Type	Method and Description
List<DocumentRoute>	DocumentRoutingService.getAvailableDocumentRouteModel(CoreSession session) Return the list of available DocumentRoute model the user can start.
List<DocumentRoute>	DocumentRoutingService.getDocumentRoutesForAttachedDocument(CoreSession session, String attachedDocId)
List<DocumentRoute>	DocumentRoutingService.getDocumentRoutesForAttachedDocument(CoreSession session, String attachedDocId, List<DocumentRouteElement.ElementLifeCycleState> states) Return the list of related DocumentRoute in a state for a given attached document.

Methods in org.nuxeo.ecm.platform.routing.api with parameters of type DocumentRoute

Modifier and Type	Method and Description
DocumentRoute	DocumentRoutingService.createNewInstance(DocumentRoute model, List<String> documentIds, CoreSession session) Deprecated. since 5.6, use other APIs
DocumentRoute	DocumentRoutingService.createNewInstance(DocumentRoute model, List<String> documentIds, CoreSession session, boolean startInstance) Create a new DocumentRoute instance from this DocumentRoute model.
DocumentRoute	DocumentRoutingService.createNewInstance(DocumentRoute model, String documentId, CoreSession session) Deprecated. since 5.6, use other APIs
DocumentRoute	DocumentRoutingService.createNewInstance(DocumentRoute model, String documentId, CoreSession session, boolean startInstance) Deprecated. since 5.6, use other APIs
void	DocumentRoutingService.finishTask(CoreSession session, DocumentRoute route, Task task, boolean delete) Deprecated. // will be removed in 5.8, use completeTask instead
List<DocumentRouteTableElement>	DocumentRoutingService.getRouteElements(DocumentRoute route, CoreSession session) Computes the list of elements DocumentRouteTableElement for this DocumentRoute.
boolean	DocumentRoutingService.isLockedByCurrentUser(DocumentRoute routeModel, CoreSession session) Verify is this DocumentRoute is already locked by the current user.
void	DocumentRoutingService.lockDocumentRoute(DocumentRoute routeModel, CoreSession session) Locks this DocumentRoute if not already locked by the current user.
DocumentRoute	DocumentRoutingService.saveRouteAsNewModel(DocumentRoute route, CoreSession session) Save a route instance as a new model of route.
void	DocumentRoutingService.unlockDocumentRoute(DocumentRoute routeModel, CoreSession session) Unlocks this DocumentRoute.If the document is not locked throws a DocumentRouteNotLockedException
DocumentRoute	DocumentRoutingService.unlockDocumentRouteUnrestrictedSession(DocumentRoute routeModel, CoreSession userSession) Unlock the given DocumentRoute model under unrestricted session.
DocumentRoute	DocumentRoutingService.validateRouteModel(DocumentRoute routeModel, CoreSession session) Validates the given DocumentRoute model by changing its lifecycle state and setting it and all its children in ReadOnly.

Constructors in org.nuxeo.ecm.platform.routing.api with parameters of type DocumentRoute

Constructor and Description
RouteTable(DocumentRoute route) Deprecated.

Uses of DocumentRoute in org.nuxeo.ecm.platform.routing.core.api

Methods in org.nuxeo.ecm.platform.routing.core.api with parameters of type DocumentRoute

Modifier and Type	Method and Description
void	DocumentRoutingEngineService.cancel(DocumentRoute routeInstance, CoreSession session) Cancels a route using an unrestricted session.
void	DocumentRoutingEngineService.resume(DocumentRoute routeInstance, String nodeId, String taskId, Map<String,Object> data, String status, CoreSession session) Resumes a route, optionnally for a given task only.
void	DocumentRoutingEngineService.start(DocumentRoute routeInstance, Map<String,Serializable> map, CoreSession session) Starts a route.

Uses of DocumentRoute in org.nuxeo.ecm.platform.routing.core.impl

Classes in org.nuxeo.ecm.platform.routing.core.impl that implement DocumentRoute

Modifier and Type	Class and Description
class	DocumentRouteImpl
class	GraphRouteImpl

Methods in org.nuxeo.ecm.platform.routing.core.impl that return DocumentRoute

Modifier and Type	Method and Description
DocumentRoute	DocumentRoutingServiceImpl.createNewInstance(DocumentRoute model, List<String> documentIds, CoreSession session) Deprecated.
DocumentRoute	DocumentRoutingServiceImpl.createNewInstance(DocumentRoute model, List<String> docIds, CoreSession session, boolean startInstance)
DocumentRoute	DocumentRoutingServiceImpl.createNewInstance(DocumentRoute model, String documentId, CoreSession session) Deprecated.
DocumentRoute	DocumentRoutingServiceImpl.createNewInstance(DocumentRoute model, String documentId, CoreSession session, boolean startInstance) Deprecated.
DocumentRoute	DocumentRouteElementImpl.getDocumentRoute(CoreSession session)
DocumentRoute	DocumentRoutingServiceImpl.getRouteModelWithId(CoreSession session, String id)
DocumentRoute	DocumentRoutingServiceImpl.importRouteModel(URL modelToImport, boolean overwrite, CoreSession session)
DocumentRoute	DocumentRoutingServiceImpl.saveRouteAsNewModel(DocumentRoute instance, CoreSession session)
DocumentRoute	GraphNodeImpl.startSubRoute()
DocumentRoute	GraphNode.startSubRoute() Starts the sub-route on this node.
DocumentRoute	DocumentRoutingServiceImpl.unlockDocumentRouteUnrestrictedSession(DocumentRoute routeModel, CoreSession userSession)
DocumentRoute	DocumentRoutingServiceImpl.validateRouteModel(DocumentRoute routeModel, CoreSession userSession)

Methods in org.nuxeo.ecm.platform.routing.core.impl that return types with arguments of type DocumentRoute

Modifier and Type	Method and Description
List<DocumentRoute>	DocumentRoutingServiceImpl.getAvailableDocumentRouteModel(CoreSession session)
List<DocumentRoute>	DocumentRoutingServiceImpl.getDocumentRoutesForAttachedDocument(CoreSession session, String attachedDocId)
List<DocumentRoute>	DocumentRoutingServiceImpl.getDocumentRoutesForAttachedDocument(CoreSession session, String attachedDocId, List<DocumentRouteElement.ElementLifeCycleState> states)

Methods in org.nuxeo.ecm.platform.routing.core.impl with parameters of type DocumentRoute

Modifier and Type	Method and Description
void	DocumentRoutingEngineServiceImpl.cancel(DocumentRoute routeInstance, CoreSession session)
DocumentRoute	DocumentRoutingServiceImpl.createNewInstance(DocumentRoute model, List<String> documentIds, CoreSession session) Deprecated.
DocumentRoute	DocumentRoutingServiceImpl.createNewInstance(DocumentRoute model, List<String> docIds, CoreSession session, boolean startInstance)
DocumentRoute	DocumentRoutingServiceImpl.createNewInstance(DocumentRoute model, String documentId, CoreSession session) Deprecated.
DocumentRoute	DocumentRoutingServiceImpl.createNewInstance(DocumentRoute model, String documentId, CoreSession session, boolean startInstance) Deprecated.
void	DocumentRoutingServiceImpl.finishTask(CoreSession session, DocumentRoute route, Task task, boolean delete)
List<DocumentRouteTableElement>	DocumentRoutingServiceImpl.getRouteElements(DocumentRoute route, CoreSession session) Deprecated. since 5.9.2 - Use only routes of type 'graph'
boolean	DocumentRoutingServiceImpl.isLockedByCurrentUser(DocumentRoute routeModel, CoreSession session)
void	DocumentRoutingServiceImpl.lockDocumentRoute(DocumentRoute routeModel, CoreSession session)
void	DocumentRoutingEngineServiceImpl.resume(DocumentRoute routeInstance, String nodeId, String taskId, Map<String,Object> data, String status, CoreSession session)
DocumentRoute	DocumentRoutingServiceImpl.saveRouteAsNewModel(DocumentRoute instance, CoreSession session)
void	DocumentRoutingEngineServiceImpl.start(DocumentRoute routeInstance, Map<String,Serializable> map, CoreSession session)
void	DocumentRoutingServiceImpl.unlockDocumentRoute(DocumentRoute routeModel, CoreSession session)
DocumentRoute	DocumentRoutingServiceImpl.unlockDocumentRouteUnrestrictedSession(DocumentRoute routeModel, CoreSession userSession)
DocumentRoute	DocumentRoutingServiceImpl.validateRouteModel(DocumentRoute routeModel, CoreSession userSession)

Uses of DocumentRoute in org.nuxeo.ecm.platform.routing.web

Methods in org.nuxeo.ecm.platform.routing.web that return DocumentRoute

Modifier and Type	Method and Description
DocumentRoute	DocumentRoutingActionsBean.getRelatedRoute() Gets the first related route.

Methods in org.nuxeo.ecm.platform.routing.web that return types with arguments of type DocumentRoute

Modifier and Type	Method and Description
List<DocumentRoute>	DocumentRoutingActionsBean.getRelatedRoutes() Gets the list of routes related to the current document, by querying the routing service.

Methods in org.nuxeo.ecm.platform.routing.web with parameters of type DocumentRoute

Modifier and Type	Method and Description
boolean	DocumentRoutingActionsBean.isRouteGraph(DocumentRoute route) Checks if a given route is a Graph.