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.

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

Fields in org.nuxeo.ecm.platform.routing.api declared as DocumentRoute

Modifier and Type	Field and Description
protected DocumentRoute	RouteTable.route Deprecated.

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.