Index (Nuxeo Routing API 6.1.1 API)

A B C D E F G I L M N O P R S T U V W _

A

ActionableObject - Interface in org.nuxeo.ecm.platform.routing.api: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
ActionableValidator - Class in org.nuxeo.ecm.platform.routing.api.helper: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
ActionableValidator(ActionableObject, CoreSession) - Constructor for class org.nuxeo.ecm.platform.routing.api.helper.ActionableValidator: Deprecated.
ActionableValidator(ActionableObject, CoreSession, Map<String, Serializable>) - Constructor for class org.nuxeo.ecm.platform.routing.api.helper.ActionableValidator: Deprecated.
actionnable - Variable in class org.nuxeo.ecm.platform.routing.api.helper.ActionableValidator: Deprecated.
additionalProperties - Variable in class org.nuxeo.ecm.platform.routing.api.helper.ActionableValidator: Deprecated.
addRouteElementToRoute(DocumentRef, int, DocumentRouteElement, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
addRouteElementToRoute(DocumentRef, String, DocumentRouteElement, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
ATTACHED_DOCUMENTS_PROPERTY_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants

B

backToReady(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: Set the step back to the ready state from running or done.
batchSize - Variable in class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow
BulkRestartWorkflow - Class in org.nuxeo.ecm.platform.routing.api.operation: Bulk operation to cancel and restart all the workflow instances of the workflow model with the id workflowId.
BulkRestartWorkflow() - Constructor for class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow

C

cancel(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: Cancel this element.
cancelTask(CoreSession, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Cancels an open task.
canDeleteStep(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: If this session can delete this step.
canUndoStep(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: If this step can be undone.
canUpdateStep(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: If this session can update this step.
canUserValidateRoute(NuxeoPrincipal) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
use DocumentRoutingService.canValidateRoute(DocumentModel, CoreSession) instead.
canValidateRoute(DocumentModel, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Checks if the principal that created the client session can validate the route
canValidateStep(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: If this session can validate the step.
cleanupDoneAndCanceledRouteInstances(String, int) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Query for the routes 'done' or 'canceled' and delete them.
COMMENTS_INFO_HOLDER_FACET - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
COMMENTS_NO_PROPERTY_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
completeTask(String, String, Map<String, Object>, String, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Completes a task on a give node.
computeFirstChildList() - Method in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
CONDITIONAL_STEP_DOCUMENT_TYPE - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants: Deprecated.
CONDITIONAL_STEP_FACET - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants: Deprecated.
ConditionalFolderUpdateRunner - Class in org.nuxeo.ecm.platform.routing.api.helper: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
ConditionalFolderUpdateRunner(String) - Constructor for class org.nuxeo.ecm.platform.routing.api.helper.ConditionalFolderUpdateRunner: Deprecated.
context - Variable in class org.nuxeo.ecm.platform.routing.api.operation.ResumeStepOperation: Deprecated.
context - Variable in class org.nuxeo.ecm.platform.routing.api.operation.SetNextStepOnConditionalFolderOperation: Deprecated.
context - Variable in class org.nuxeo.ecm.platform.routing.api.operation.StepBackToReadyOperation: Deprecated.
context - Variable in class org.nuxeo.ecm.platform.routing.api.operation.StepDoneOperation: Deprecated.
createDocumentRouteInstanceFromDocumentRouteModel(DocumentModel, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingPersister: Creates a blank DocumentRoute instance from a model.
createNewInstance(String, List<String>, Map<String, Serializable>, CoreSession, boolean) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Creates a new route instance and optionally starts it.
createNewInstance(String, List<String>, CoreSession, boolean) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Creates a new route instance and optionally starts it.
createNewInstance(DocumentRoute, List<String>, CoreSession, boolean) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Create a new DocumentRoute instance from this DocumentRoute model.
createNewInstance(DocumentRoute, String, CoreSession, boolean) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
since 5.6, use other APIs
createNewInstance(DocumentRoute, List<String>, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
since 5.6, use other APIs
createNewInstance(DocumentRoute, String, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
since 5.6, use other APIs
ctx - Variable in class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow
ctx - Variable in class org.nuxeo.ecm.platform.routing.api.operation.MapPropertiesOnTaskOperation
ctx - Variable in class org.nuxeo.ecm.platform.routing.api.operation.SetWorkflowNodeVar

D

DEFAULT_BATCH_SIZE - Static variable in class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow
delegateTask(CoreSession, String, List<String>, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Reassigns the given task to the list of actors.
depth - Variable in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
depth - Variable in class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
DESCRIPTION_PROPERTY_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DOC_ROUTING_SEARCH_ALL_ROUTE_MODELS_PROVIDER_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DOC_ROUTING_SEARCH_ROUTE_MODELS_WITH_TITLE_PROVIDER_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
doCleanupDoneAndCanceledRouteInstances(String, int) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Query for the routes 'done' or 'canceled' and delete them.
DOCUMENT_ELEMENT_EVENT_CONTEXT_KEY - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DOCUMENT_ROUTE_DOCUMENT_FACET - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DOCUMENT_ROUTE_DOCUMENT_TYPE - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DOCUMENT_ROUTE_INSTANCES_ROOT_DOCUMENT_TYPE - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DOCUMENT_ROUTE_INSTANCES_ROOT_ID - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DOCUMENT_ROUTE_MODELS_ROOT_DOCUMENT_TYPE - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DOCUMENT_ROUTE_MODELS_ROOT_ID - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DOCUMENT_ROUTING_ACL - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DOCUMENT_ROUTING_DELEGATION_ACL - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
DocumentRoute - Interface in org.nuxeo.ecm.platform.routing.api: A DocumentRoute model or instance.
DocumentRouteAlredayLockedException - Exception in org.nuxeo.ecm.platform.routing.api.exception
DocumentRouteAlredayLockedException() - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteAlredayLockedException
DocumentRouteAlredayLockedException(String) - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteAlredayLockedException
DocumentRouteAlredayLockedException(Throwable) - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteAlredayLockedException
DocumentRouteAlredayLockedException(String, Throwable) - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteAlredayLockedException
DocumentRouteElement - Interface in org.nuxeo.ecm.platform.routing.api: An element of a DocumentRoute
DocumentRouteElement.ElementLifeCycleState - Enum in org.nuxeo.ecm.platform.routing.api: The lifecycle state of an element
DocumentRouteElement.ElementLifeCycleTransistion - Enum in org.nuxeo.ecm.platform.routing.api: The transition of the lifecycle state.
DocumentRouteException - Exception in org.nuxeo.ecm.platform.routing.api.exception: Basic document routing exception.
DocumentRouteException() - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteException
DocumentRouteException(String) - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteException
DocumentRouteException(Throwable) - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteException
DocumentRouteException(String, Throwable) - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteException
DocumentRouteInstanceRootName - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingPersister: The name of the document in which will be create
DocumentRouteNotLockedException - Exception in org.nuxeo.ecm.platform.routing.api.exception
DocumentRouteNotLockedException() - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteNotLockedException
DocumentRouteNotLockedException(String) - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteNotLockedException
DocumentRouteNotLockedException(Throwable) - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteNotLockedException
DocumentRouteNotLockedException(String, Throwable) - Constructor for exception org.nuxeo.ecm.platform.routing.api.exception.DocumentRouteNotLockedException
DocumentRouteStep - Interface in org.nuxeo.ecm.platform.routing.api: A Step.
DocumentRouteStepsContainer - Interface in org.nuxeo.ecm.platform.routing.api: A container of steps.
DocumentRouteTableElement - Class in org.nuxeo.ecm.platform.routing.api: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
DocumentRouteTableElement(DocumentRouteElement, RouteTable, int, RouteFolderElement, boolean) - Constructor for class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
DocumentRoutingConstants - Interface in org.nuxeo.ecm.platform.routing.api
DocumentRoutingConstants.Events - Enum in org.nuxeo.ecm.platform.routing.api
DocumentRoutingConstants.ExecutionTypeValues - Enum in org.nuxeo.ecm.platform.routing.api
DocumentRoutingPersister - Interface in org.nuxeo.ecm.platform.routing.api: The DocumentRoutingPersister is responsible creating a folder structure to persist DocumentRoute instance, persisting new DocumentRoute instances and creating DocumentRoute model from DocumentRoute instance.
DocumentRoutingService - Interface in org.nuxeo.ecm.platform.routing.api: The DocumentRoutingService allows manipulation of DocumentRoutes.

E

element - Variable in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
element - Variable in class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
endTask(CoreSession, Task, Map<String, Object>, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Ends a task.
endTask(CoreSession, Task, Map<String, Object>, String) - Method in interface org.nuxeo.ecm.platform.routing.api.RoutingTaskService: Deprecated.
since 5.6, use DocumentRoutingService instead
EXECUTION_TYPE_PROPERTY_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants

F

finishTask(CoreSession, DocumentRoute, Task, boolean) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
// will be removed in 5.8, use completeTask instead
firstChildList - Variable in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
followTransition(DocumentRouteElement.ElementLifeCycleTransistion, CoreSession, boolean) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: make this element follow a transition.

G

getAttachedDocuments(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.ActionableObject: Deprecated.

The documents processed by the action.
getAttachedDocuments() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoute: The list of documents processed by this route.
getAttachedDocuments(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: Return the list of documents that this route processes.
getAutomationService() - Method in class org.nuxeo.ecm.platform.routing.api.helper.ActionableValidator: Deprecated.
getAvailableDocumentRouteModel(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Return the list of available DocumentRoute model the user can start.
getDepth() - Method in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
getDepth() - Method in class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
getDescription() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: the description of this element.
getDocument() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: Get the underlying document representing this element.
getDocument() - Method in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
getDocumentRoute(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: Return the DocumentRoute this element is part of.
getDocumentRoutesForAttachedDocument(CoreSession, String, List<DocumentRouteElement.ElementLifeCycleState>) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Return the list of related DocumentRoute in a state for a given attached document.
getDocumentRoutesForAttachedDocument(CoreSession, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService
getDocumentRouteStep(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.ActionableObject: Deprecated.

The step that represent the action.
getElement() - Method in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
getFirstChildFolders() - Method in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
getId() - Method in class org.nuxeo.ecm.platform.routing.api.RouteModelResourceType
getLockOwner(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.LockableDocumentRoute
getMaxDepth() - Method in class org.nuxeo.ecm.platform.routing.api.RouteTable: Deprecated.
getName() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: The name of this element.
getNewModelName(DocumentModel) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingPersister: Return the new name of a model when it is created from an instance.
getOperationChainId(String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
getOrCreateRootOfDocumentRouteInstanceStructure(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingPersister: Will get, and create if it does not exists the root document in which DocumentRoute structure will be created.
getOrderedRouteElement(String, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
getParent() - Method in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
getParentFolderForDocumentRouteInstance(DocumentModel, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingPersister: Get or create the parent folder for a DocumentRoute route instance.
getParentFolderForDocumentRouteModels(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingPersister: Gets or creates the parent folder for a DocumentRoute route instance.
getParentFolderForNewModel(CoreSession, DocumentModel) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingPersister: Returns a folder in which new model, created from an instance of route will be stored.
getPath() - Method in class org.nuxeo.ecm.platform.routing.api.RouteModelResourceType
getRefuseOperationChainId() - Method in interface org.nuxeo.ecm.platform.routing.api.ActionableObject: Deprecated.

The operation chain id if the action is refused.
getRouteElement() - Method in class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
getRouteElements(DocumentRoute, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Computes the list of elements DocumentRouteTableElement for this DocumentRoute.
getRouteMaxDepth() - Method in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
getRouteModelDocIdWithId(CoreSession, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Returns the doc id of the route model with the given id
getRouteModelTemplateResources() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Returns all the route models resource templates.
getRouteModelWithId(CoreSession, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Returns the route model with the given id
getRouteTable() - Method in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
getTotalChildCount() - Method in class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
getTotalChildCount() - Method in class org.nuxeo.ecm.platform.routing.api.RouteTable: Deprecated.
getUndoFromDoneOperationChainId(String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Return the operation chain to undo a step when the step is in done state.
getUndoFromRunningOperationChainId(String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
getUrl() - Method in class org.nuxeo.ecm.platform.routing.api.RouteModelResourceType
getValidateOperationChainId() - Method in interface org.nuxeo.ecm.platform.routing.api.ActionableObject: Deprecated.

The operation chain id if the action is validated.
getWorkflowInputDocuments(CoreSession, Task) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Gets the documents following the workflow to which the given task belongs
getWorkflowInputDocuments(CoreSession, Task) - Method in interface org.nuxeo.ecm.platform.routing.api.RoutingTaskService: Deprecated.
since 5.6, use DocumentRoutingService instead
grantPermissionToTaskAssignees(CoreSession, String, List<DocumentModel>, Task) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Grants on these documents the specified assignees permissions for this task.
grantPermissionToTaskDelegatedActors(CoreSession, String, List<DocumentModel>, Task) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Grants on these documents the specified assignees permissions for this task to the tasks delegated actors.

I

ID - Static variable in class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow
ID - Static variable in class org.nuxeo.ecm.platform.routing.api.operation.MapPropertiesOnTaskOperation
ID - Static variable in class org.nuxeo.ecm.platform.routing.api.operation.ResumeStepOperation: Deprecated.
ID - Static variable in class org.nuxeo.ecm.platform.routing.api.operation.SetNextStepOnConditionalFolderOperation: Deprecated.
ID - Static variable in class org.nuxeo.ecm.platform.routing.api.operation.SetWorkflowNodeVar
ID - Static variable in class org.nuxeo.ecm.platform.routing.api.operation.StepBackToReadyOperation: Deprecated.
ID - Static variable in class org.nuxeo.ecm.platform.routing.api.operation.StepDoneOperation: Deprecated.
ID - Static variable in class org.nuxeo.ecm.platform.routing.api.operation.UpdateCommentsInfoOnDocumentOperation
id - Variable in class org.nuxeo.ecm.platform.routing.api.RouteModelResourceType
importRouteModel(URL, boolean, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Creates a route model in the root models folder defined by the current persister.
increaseTotalChildCount() - Method in class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
increaseTotalChildCount() - Method in class org.nuxeo.ecm.platform.routing.api.RouteTable: Deprecated.
INITIATOR - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
INITIATOR_EVENT_CONTEXT_KEY - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
invalidateRouteModelsCache() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService
isCanceled() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement
isDone() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: if this route is done.
isDraft() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: if this route is draft.
isFirstChild - Variable in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
isFirstChild - Variable in class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
isLocked(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.LockableDocumentRoute
isLockedByCurrentUser(DocumentRoute, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Verify is this DocumentRoute is already locked by the current user.
isLockedByCurrentUser(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.LockableDocumentRoute
isModifiable() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement
isReady() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: if this element is ready.
isRoutable(DocumentModel) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Checks if the given document can be associated to a DocumentRoute.
isRunning() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: if this route is running.
isValidated() - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: if the route this element is part of has been validated.

L

LockableDocumentRoute - Interface in org.nuxeo.ecm.platform.routing.api
lockDocument(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.LockableDocumentRoute
lockDocumentRoute(DocumentRoute, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Locks this DocumentRoute if not already locked by the current user.

M

makeRoutingTasks(CoreSession, List<Task>) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Marks the tasks as Routing tasks.
makeRoutingTasks(CoreSession, List<Task>) - Method in interface org.nuxeo.ecm.platform.routing.api.RoutingTaskService: Deprecated.
since 5.6, use DocumentRoutingService instead
mappingName - Variable in class org.nuxeo.ecm.platform.routing.api.operation.MapPropertiesOnTaskOperation
mappingService - Variable in class org.nuxeo.ecm.platform.routing.api.operation.MapPropertiesOnTaskOperation
MapPropertiesOnTaskOperation - Class in org.nuxeo.ecm.platform.routing.api.operation: Applies the mapping passed as parameter on the input task document.
MapPropertiesOnTaskOperation() - Constructor for class org.nuxeo.ecm.platform.routing.api.operation.MapPropertiesOnTaskOperation
maxDepth - Variable in class org.nuxeo.ecm.platform.routing.api.RouteTable: Deprecated.

N

name - Variable in class org.nuxeo.ecm.platform.routing.api.operation.SetWorkflowNodeVar
nextStepPos - Variable in class org.nuxeo.ecm.platform.routing.api.operation.SetNextStepOnConditionalFolderOperation: Deprecated.
nodeId - Variable in class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow

O

OPERATION_CATEGORY_ROUTING_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
OPERATION_STEP_DOCUMENT_KEY - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
org.nuxeo.ecm.platform.routing.api - package org.nuxeo.ecm.platform.routing.api: Provides the interfaces necessary to create and manipulate DocumentRoute.
org.nuxeo.ecm.platform.routing.api.exception - package org.nuxeo.ecm.platform.routing.api.exception
org.nuxeo.ecm.platform.routing.api.helper - package org.nuxeo.ecm.platform.routing.api.helper: Helper classes to restart a DocumentRoute from a waiting state.
org.nuxeo.ecm.platform.routing.api.operation - package org.nuxeo.ecm.platform.routing.api.operation: Provides operations for pertaining to routing.

P

parent - Variable in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
parent - Variable in class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
path - Variable in class org.nuxeo.ecm.platform.routing.api.RouteModelResourceType

R

reassignTask(CoreSession, String, List<String>, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Reassigns the given task to the list of actors.
refuse() - Method in class org.nuxeo.ecm.platform.routing.api.helper.ActionableValidator: Deprecated.
registerRouteResource(RouteModelResourceType, RuntimeContext) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Registers a new route model template to be imported at application startup.
reinitLifecycle - Variable in class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow
reinitLifecycle(List<String>, CoreSession) - Method in class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow
removePermissionFromTaskAssignees(CoreSession, List<DocumentModel>, Task) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Removes on these documents the specified assignees permissions for this task.
removePermissionsForTaskActors(CoreSession, List<DocumentModel>, Task) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Removes on these documents the specified assignees permissions for the task actors and also tasks delegated actors if this task was delegated
removePermissionsForTaskActors(CoreSession, List<DocumentModel>, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Removes on these documents the specified assignees permissions for the task actors and also tasks delegated actors if this task was delegated
removeRouteElement(DocumentRouteElement, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
resume(CoreSession, String, String, Map<String, Object>, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: Resumes execution on a route node.
resume() - Method in class org.nuxeo.ecm.platform.routing.api.operation.ResumeStepOperation: Deprecated.
resumeInstance(String, String, Map<String, Object>, String, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Resumes a route instance on a give node.
resumeStep(CoreSession) - Method in class org.nuxeo.ecm.platform.routing.api.helper.StepResumeRunner: Deprecated.
ResumeStepOperation - Class in org.nuxeo.ecm.platform.routing.api.operation: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
ResumeStepOperation() - Constructor for class org.nuxeo.ecm.platform.routing.api.operation.ResumeStepOperation: Deprecated.
route - Variable in class org.nuxeo.ecm.platform.routing.api.RouteTable: Deprecated.
ROUTE_MANAGERS_GROUP_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
ROUTE_STEP_FACET - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
ROUTE_TASK_LOCAL_ACL - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
RouteFolderElement - Class in org.nuxeo.ecm.platform.routing.api: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
RouteFolderElement(DocumentRouteElement, RouteTable, boolean, RouteFolderElement, int) - Constructor for class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
RouteModelResourceType - Class in org.nuxeo.ecm.platform.routing.api
RouteModelResourceType() - Constructor for class org.nuxeo.ecm.platform.routing.api.RouteModelResourceType
RouteTable - Class in org.nuxeo.ecm.platform.routing.api: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
RouteTable(DocumentRoute) - Constructor for class org.nuxeo.ecm.platform.routing.api.RouteTable: Deprecated.
routing - Variable in class org.nuxeo.ecm.platform.routing.api.operation.MapPropertiesOnTaskOperation
ROUTING_CATEGORY - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
ROUTING_TASK_FACET_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
RoutingTaskService - Interface in org.nuxeo.ecm.platform.routing.api: Deprecated.
since 5.6, use DocumentRoutingService instead
run(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: Execute this element.
run(CoreSession, Map<String, Serializable>) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: Execute this element.
run() - Method in class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow
run(DocumentModel) - Method in class org.nuxeo.ecm.platform.routing.api.operation.MapPropertiesOnTaskOperation
run() - Method in class org.nuxeo.ecm.platform.routing.api.operation.SetWorkflowNodeVar
runChain(String) - Method in class org.nuxeo.ecm.platform.routing.api.helper.ActionableValidator: Deprecated.

S

save(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: save the document representing this DocumentRoute.
saveDocumentRouteInstanceAsNewModel(DocumentModel, DocumentModel, String, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingPersister
saveRouteAsNewModel(DocumentRoute, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Save a route instance as a new model of route.
SEARCH_ROUTE_BY_ATTACHED_DOC_QUERY - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
searchRouteModels(CoreSession, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Returns the route models matching the searchString.
session - Variable in class org.nuxeo.ecm.platform.routing.api.helper.ActionableValidator: Deprecated.
session - Variable in class org.nuxeo.ecm.platform.routing.api.operation.MapPropertiesOnTaskOperation
session - Variable in class org.nuxeo.ecm.platform.routing.api.operation.SetNextStepOnConditionalFolderOperation: Deprecated.
session - Variable in class org.nuxeo.ecm.platform.routing.api.operation.UpdateCommentsInfoOnDocumentOperation
setAttachedDocuments(List<String>) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoute: Set the list of id of documents attached to this instance of RouteModel replacing the previous list if any.
setCanceled(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: Set the step to a cancel step.
setCanDeleteStep(CoreSession, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: make this user or group step deleter.
setCanReadStep(CoreSession, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: make this user or group a step reader.
setCanUpdateStep(CoreSession, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: make this user or group a step updater.
setCanValidateStep(CoreSession, String) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: make this user or group a validator for this step.
setDone(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: set this element as done.
setId(String) - Method in class org.nuxeo.ecm.platform.routing.api.RouteModelResourceType
setMaxDepth(int) - Method in class org.nuxeo.ecm.platform.routing.api.RouteTable: Deprecated.
SetNextStepOnConditionalFolderOperation - Class in org.nuxeo.ecm.platform.routing.api.operation: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
SetNextStepOnConditionalFolderOperation() - Constructor for class org.nuxeo.ecm.platform.routing.api.operation.SetNextStepOnConditionalFolderOperation: Deprecated.
setPath(String) - Method in class org.nuxeo.ecm.platform.routing.api.RouteModelResourceType
setReadOnly(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: remove write rights to everyone but the administrators.
setReady(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: set this element as ready.
setRunning(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: set this element as running.
setStepDone() - Method in class org.nuxeo.ecm.platform.routing.api.operation.StepBackToReadyOperation: Deprecated.
setStepDone() - Method in class org.nuxeo.ecm.platform.routing.api.operation.StepDoneOperation: Deprecated.
setStepToBeExcutedNext() - Method in class org.nuxeo.ecm.platform.routing.api.operation.SetNextStepOnConditionalFolderOperation: Deprecated.
setStepToBeExecutedNext(CoreSession, String) - Method in class org.nuxeo.ecm.platform.routing.api.helper.ConditionalFolderUpdateRunner: Deprecated.
setUrl(URL) - Method in class org.nuxeo.ecm.platform.routing.api.RouteModelResourceType
setValidated(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: set this element as validated.
SetWorkflowNodeVar - Class in org.nuxeo.ecm.platform.routing.api.operation: Generic fetch document operation that can be used on any context that has a document as the input.
SetWorkflowNodeVar() - Constructor for class org.nuxeo.ecm.platform.routing.api.operation.SetWorkflowNodeVar
startInstance(String, List<String>, Map<String, Serializable>, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Starts an instance that was created with DocumentRoutingService.createNewInstance(java.lang.String, java.util.List<java.lang.String>, java.util.Map<java.lang.String, java.io.Serializable>, org.nuxeo.ecm.core.api.CoreSession, boolean) but with startInstance = false.
STEP_DOCUMENT_TYPE - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
STEP_FOLDER_DOCUMENT_TYPE - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
STEP_FOLDER_FACET - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
STEP_TO_BE_EXECUTED_NEXT_PROPERTY_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants: Deprecated.
StepBackToReadyOperation - Class in org.nuxeo.ecm.platform.routing.api.operation: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
StepBackToReadyOperation() - Constructor for class org.nuxeo.ecm.platform.routing.api.operation.StepBackToReadyOperation: Deprecated.
stepDocId - Variable in class org.nuxeo.ecm.platform.routing.api.helper.ConditionalFolderUpdateRunner: Deprecated.
stepDocId - Variable in class org.nuxeo.ecm.platform.routing.api.helper.StepResumeRunner: Deprecated.
StepDoneOperation - Class in org.nuxeo.ecm.platform.routing.api.operation: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
StepDoneOperation() - Constructor for class org.nuxeo.ecm.platform.routing.api.operation.StepDoneOperation: Deprecated.
StepResumeRunner - Class in org.nuxeo.ecm.platform.routing.api.helper: Deprecated.
since 5.9.2 - Use only routes of type 'graph'
StepResumeRunner(String) - Constructor for class org.nuxeo.ecm.platform.routing.api.helper.StepResumeRunner: Deprecated.

T

table - Variable in class org.nuxeo.ecm.platform.routing.api.DocumentRouteTableElement: Deprecated.
table - Variable in class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
TASK_ASSIGNED_NOTIFICATION_TEMPLATE - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
TASK_BUTTONS_KEY - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
TASK_NODE_ID_KEY - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
TASK_ROUTE_INSTANCE_DOCUMENT_ID_KEY - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
TITLE_PROPERTY_NAME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
totalChildCount - Variable in class org.nuxeo.ecm.platform.routing.api.RouteFolderElement: Deprecated.
totalChildCount - Variable in class org.nuxeo.ecm.platform.routing.api.RouteTable: Deprecated.

U

undo(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteStep: Undo this step.
unlockDocument(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.LockableDocumentRoute
unlockDocumentRoute(DocumentRoute, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Unlocks this DocumentRoute.If the document is not locked throws a DocumentRouteNotLockedException
unlockDocumentRouteUnrestrictedSession(DocumentRoute, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Unlock the given DocumentRoute model under unrestricted session.
unwrapException(Throwable) - Static method in class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow
updateCommentsInfo() - Method in class org.nuxeo.ecm.platform.routing.api.operation.UpdateCommentsInfoOnDocumentOperation
UpdateCommentsInfoOnDocumentOperation - Class in org.nuxeo.ecm.platform.routing.api.operation: Updates the number of comments stored on the DocumentRouteStep.
UpdateCommentsInfoOnDocumentOperation() - Constructor for class org.nuxeo.ecm.platform.routing.api.operation.UpdateCommentsInfoOnDocumentOperation
updateRouteElement(DocumentRouteElement, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Update the given route element
url - Variable in class org.nuxeo.ecm.platform.routing.api.RouteModelResourceType

V

validate(CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement: Set this element to the validate state and put it in read only mode.
validate() - Method in class org.nuxeo.ecm.platform.routing.api.helper.ActionableValidator: Deprecated.
validateRouteModel(DocumentRoute, CoreSession) - Method in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingService: Validates the given DocumentRoute model by changing its lifecycle state and setting it and all its children in ReadOnly.
value - Variable in class org.nuxeo.ecm.platform.routing.api.operation.SetWorkflowNodeVar
valueOf(String) - Static method in enum org.nuxeo.ecm.platform.routing.api.DocumentRouteElement.ElementLifeCycleState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.nuxeo.ecm.platform.routing.api.DocumentRouteElement.ElementLifeCycleTransistion: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants.Events: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants.ExecutionTypeValues: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.nuxeo.ecm.platform.routing.api.DocumentRouteElement.ElementLifeCycleState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.nuxeo.ecm.platform.routing.api.DocumentRouteElement.ElementLifeCycleTransistion: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants.Events: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants.ExecutionTypeValues: Returns an array containing the constants of this enum type, in the order they are declared.

W

WORKFLOW_FORCE_RESUME - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
WORKFLOW_TASK_COMPLETION_ACTION_KEY - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants
workflowId - Variable in class org.nuxeo.ecm.platform.routing.api.operation.BulkRestartWorkflow

_

_MAP_VAR_FORMAT_JSON - Static variable in interface org.nuxeo.ecm.platform.routing.api.DocumentRoutingConstants

A B C D E F G I L M N O P R S T U V W _