DocumentRoute (Nuxeo 2021.64.6 API Documentation)

All Superinterfaces:

DocumentRouteElement, DocumentRouteStepsContainer, Serializable

All Known Subinterfaces:

GraphRoute

All Known Implementing Classes:

DocumentRouteImpl, GraphRouteImpl
```
public interface DocumentRoute
extends DocumentRouteStepsContainer
```
A DocumentRoute model or instance. A route is a set of step that processes documents. If a method is called that change the state of this object, the DocumentRouteElement.save(CoreSession) method should be called to persist its state.

Author:

arussel

Nested Class Summary
- Nested classes/interfaces inherited from interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement
  DocumentRouteElement.ElementLifeCycleState, DocumentRouteElement.ElementLifeCycleTransistion

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`List<String>`	`getAttachedDocuments()`	The list of documents processed by this route.
`String`	`getInitiator()`	Get the username of the initiator.
`String`	`getModelId()`
`String`	`getModelName()`
`void`	`setAttachedDocuments(List<String> documentIds)`	Set the list of id of documents attached to this instance of RouteModel replacing the previous list if any.

Methods inherited from interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement
backToReady, cancel, canDeleteStep, canUndoStep, canUpdateStep, canValidateStep, followTransition, getAttachedDocuments, getDescription, getDocument, getDocumentRoute, getName, getTitle, isCanceled, isDone, isDraft, isModifiable, isReady, isRunning, isValidated, resume, run, run, save, setCanceled, setCanDeleteStep, setCanReadStep, setCanUpdateStep, setCanValidateStep, setDone, setReadOnly, setReady, setRunning, setValidated, validate

- Method Detail
  - setAttachedDocuments
```
void setAttachedDocuments(List<String> documentIds)
```
    Set the list of id of documents attached to this instance of RouteModel replacing the previous list if any.
  - getAttachedDocuments
```
List<String> getAttachedDocuments()
```
    The list of documents processed by this route.
  - getInitiator
```
String getInitiator()
```
    Get the username of the initiator.
    
    Since:
    
    7.2
  - getModelId
```
String getModelId()
```
    Since:
    
    7.2
  - getModelName
```
String getModelName()
```
    Since:
    
    7.2