Uses of Interface
org.nuxeo.ecm.platform.routing.api.DocumentRoute
Package
Description
Provides the interfaces necessary to create and manipulate
DocumentRoute
.Provides internal services to the
DocumentRoutingService
Provides implementation for the api package.
-
Uses of DocumentRoute in org.nuxeo.ecm.platform.routing.api
Modifier and TypeMethodDescriptionDocumentRoutingService.createNewInstance
(DocumentRoute model, List<String> documentIds, CoreSession session, boolean startInstance) Create a newDocumentRoute
instance from thisDocumentRoute
model.DocumentRouteElement.getDocumentRoute
(CoreSession session) Return the DocumentRoute this element is part of.DocumentRoutingService.getRouteModelWithId
(CoreSession session, String id) Returns the route model with the given idDocumentRoutingService.importRouteModel
(URL templateResource, boolean overwrite, CoreSession session) Creates a route model in the root models folder defined by the current persister.DocumentRoutingService.saveRouteAsNewModel
(DocumentRoute route, CoreSession session) Save a route instance as a new model of route.DocumentRoutingService.unlockDocumentRouteUnrestrictedSession
(DocumentRoute routeModel, CoreSession userSession) Unlock the givenDocumentRoute
model under unrestricted session.DocumentRoutingService.validateRouteModel
(DocumentRoute routeModel, CoreSession session) Validates the givenDocumentRoute
model by changing its lifecycle state and setting it and all its children in ReadOnly.Modifier and TypeMethodDescriptionDocumentRoutingService.getAvailableDocumentRoute
(CoreSession session) Return the list of availableDocumentRoute
document route.DocumentRoutingService.getAvailableDocumentRouteModel
(CoreSession session) Return the list of availableDocumentRoute
model the user can start.DocumentRoutingService.getDocumentRelatedWorkflows
(DocumentModel document, CoreSession session) DocumentRoutingService.getDocumentRoutesForAttachedDocument
(CoreSession session, String attachedDocId) DocumentRoutingService.getDocumentRoutesForAttachedDocument
(CoreSession session, String attachedDocId, List<DocumentRouteElement.ElementLifeCycleState> states) Return the list of relatedDocumentRoute
in a state for a given attached document.DocumentRoutingService.getRunnableWorkflows
(CoreSession session, List<String> documentIds) Returns a list of runnable document routes for the input document IDs.DocumentRoutingService.getRunningWorkflowInstancesLaunchedByCurrentUser
(CoreSession session) DocumentRoutingService.getRunningWorkflowInstancesLaunchedByCurrentUser
(CoreSession session, String worflowModelName) Modifier and TypeMethodDescriptionDocumentRoutingService.createNewInstance
(DocumentRoute model, List<String> documentIds, CoreSession session, boolean startInstance) Create a newDocumentRoute
instance from thisDocumentRoute
model.boolean
DocumentRoutingService.isLockedByCurrentUser
(DocumentRoute routeModel, CoreSession session) Verify is thisDocumentRoute
is already locked by the current user.boolean
DocumentRoutingService.isWorkflowModel
(DocumentRoute documentRoute) Returns true if the document route is a model, false if it is just an instance i.e. a running workflow.void
DocumentRoutingService.lockDocumentRoute
(DocumentRoute routeModel, CoreSession session) Locks thisDocumentRoute
if not already locked by the current user.boolean
DocumentRoutingService.purgeDocumentRoute
(CoreSession session, DocumentRoute route) Remove the workflow instance if it is canceled, done or orphan.DocumentRoutingService.saveRouteAsNewModel
(DocumentRoute route, CoreSession session) Save a route instance as a new model of route.void
DocumentRoutingService.unlockDocumentRoute
(DocumentRoute routeModel, CoreSession session) Unlocks thisDocumentRoute
.If the document is not locked throws aDocumentRouteNotLockedException
DocumentRoutingService.unlockDocumentRouteUnrestrictedSession
(DocumentRoute routeModel, CoreSession userSession) Unlock the givenDocumentRoute
model under unrestricted session.DocumentRoutingService.validateRouteModel
(DocumentRoute routeModel, CoreSession session) Validates the givenDocumentRoute
model by changing its lifecycle state and setting it and all its children in ReadOnly. -
Uses of DocumentRoute in org.nuxeo.ecm.platform.routing.core.api
Modifier and TypeMethodDescriptionvoid
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
Modifier and TypeInterfaceDescriptioninterface
A route graph, defining a workflow with arbitrarily complex transitions between nodes.Modifier and TypeMethodDescriptionDocumentRoutingServiceImpl.createNewInstance
(DocumentRoute model, List<String> docIds, CoreSession session, boolean startInstance) DocumentRouteElementImpl.getDocumentRoute
(CoreSession session) DocumentRoutingServiceImpl.getRouteModelWithId
(CoreSession session, String id) DocumentRoutingServiceImpl.importRouteModel
(URL modelToImport, boolean overwrite, CoreSession session) DocumentRoutingServiceImpl.saveRouteAsNewModel
(DocumentRoute instance, CoreSession session) GraphNode.startSubRoute()
Starts the sub-route on this node.GraphNodeImpl.startSubRoute()
DocumentRoutingServiceImpl.unlockDocumentRouteUnrestrictedSession
(DocumentRoute routeModel, CoreSession userSession) DocumentRoutingServiceImpl.validateRouteModel
(DocumentRoute routeModel, CoreSession userSession) Modifier and TypeMethodDescriptionDocumentRoutingServiceImpl.getAvailableDocumentRoute
(CoreSession session) DocumentRoutingServiceImpl.getAvailableDocumentRouteModel
(CoreSession session) DocumentRoutingServiceImpl.getDocumentRelatedWorkflows
(DocumentModel document, CoreSession session) DocumentRoutingServiceImpl.getDocumentRoutesForAttachedDocument
(CoreSession session, String attachedDocId) DocumentRoutingServiceImpl.getDocumentRoutesForAttachedDocument
(CoreSession session, String attachedDocId, List<DocumentRouteElement.ElementLifeCycleState> states) DocumentRoutingServiceImpl.getRunnableWorkflows
(CoreSession session, List<String> documentIds) DocumentRoutingServiceImpl.getRunningWorkflowInstancesLaunchedByCurrentUser
(CoreSession session) DocumentRoutingServiceImpl.getRunningWorkflowInstancesLaunchedByCurrentUser
(CoreSession session, String worflowModelName) Modifier and TypeMethodDescriptionvoid
DocumentRoutingEngineServiceImpl.cancel
(DocumentRoute routeInstance, CoreSession session) DocumentRoutingServiceImpl.createNewInstance
(DocumentRoute model, List<String> docIds, CoreSession session, boolean startInstance) protected static void
DocumentRoutingServiceImpl.fireEvent
(String eventName, Map<String, Serializable> eventProperties, DocumentRoute route, CoreSession session) protected void
DocumentRoutingServiceImpl.fireEventAfterWorkflowStarted
(DocumentRoute route, CoreSession session) boolean
DocumentRoutingServiceImpl.isLockedByCurrentUser
(DocumentRoute routeModel, CoreSession session) boolean
DocumentRoutingServiceImpl.isWorkflowModel
(DocumentRoute documentRoute) Returns true id the document route is a model, false if it is just an instance i.e. a running workflow.void
DocumentRoutingServiceImpl.lockDocumentRoute
(DocumentRoute routeModel, CoreSession session) boolean
DocumentRoutingServiceImpl.purgeDocumentRoute
(CoreSession session, DocumentRoute route) void
DocumentRoutingEngineServiceImpl.resume
(DocumentRoute routeInstance, String nodeId, String taskId, Map<String, Object> data, String status, CoreSession session) DocumentRoutingServiceImpl.saveRouteAsNewModel
(DocumentRoute instance, CoreSession session) void
DocumentRoutingEngineServiceImpl.start
(DocumentRoute routeInstance, Map<String, Serializable> map, CoreSession session) void
DocumentRoutingServiceImpl.unlockDocumentRoute
(DocumentRoute routeModel, CoreSession session) DocumentRoutingServiceImpl.unlockDocumentRouteUnrestrictedSession
(DocumentRoute routeModel, CoreSession userSession) DocumentRoutingServiceImpl.validateRouteModel
(DocumentRoute routeModel, CoreSession userSession) -
Uses of DocumentRoute in org.nuxeo.ecm.platform.routing.core.io
Modifier and TypeMethodDescriptionstatic String
DocumentRouteWriter.getGraphResourceURL
(DocumentRoute route, RenderingContext ctx) protected void
DocumentRouteWriter.writeEntityBody
(DocumentRoute item, com.fasterxml.jackson.core.JsonGenerator jg) static void
DocumentRouteWriter.writeVariables
(DocumentRoute item, com.fasterxml.jackson.core.JsonGenerator jg, MarshallerRegistry registry, RenderingContext ctx, SchemaManager schemaManager) static void
TaskWriter.writeWorkflowVariables
(DocumentRoute route, GraphNode node, com.fasterxml.jackson.core.JsonGenerator jg, MarshallerRegistry registry, RenderingContext ctx, SchemaManager schemaManager) -
Uses of DocumentRoute in org.nuxeo.ecm.restapi.server.jaxrs.routing
Modifier and TypeMethodDescriptionWorkflowObject.getWorkflowInstance
(String workflowInstanceId) WorkflowModelObject.getWorkflowModel
(String modelName) Modifier and TypeMethodDescriptionWorkflowObject.getRunningWorkflowInstancesLaunchedByCurrentUser
(String worflowModelName) WorkflowModelObject.getWorkflowModels
(javax.ws.rs.core.UriInfo uriInfo) Modifier and TypeMethodDescriptionprotected void
WorkflowObject.checkCancelGuards
(DocumentRoute route) -
Uses of DocumentRoute in org.nuxeo.ecm.restapi.server.jaxrs.routing.adapter