org.nuxeo.ecm.platform.routing.api

Interface DocumentRoutingService

All Known Implementing Classes:

DocumentRoutingServiceImpl

public interface DocumentRoutingService

The DocumentRoutingService allows manipulation of DocumentRoutes.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRouteElementToRoute(DocumentRef parentDocumentRef, int idx, DocumentRouteElement routeElement, CoreSession session) Deprecated. since 5.9.2 - Use only routes of type 'graph'
void	addRouteElementToRoute(DocumentRef parentDocumentRef, String sourceName, DocumentRouteElement routeElement, CoreSession session) Deprecated. since 5.9.2 - Use only routes of type 'graph'
void	cancelTask(CoreSession session, String taskId) Cancels an open task.
boolean	canUserValidateRoute(NuxeoPrincipal currentUser) Deprecated. use canValidateRoute(DocumentModel, CoreSession) instead.
boolean	canValidateRoute(DocumentModel documentRoute, CoreSession coreSession) Checks if the principal that created the client session can validate the route
void	cleanupDoneAndCanceledRouteInstances(String repositoryName, int limit) Query for the routes 'done' or 'canceled' and delete them.
void	completeTask(String routeId, String taskId, Map<String,Object> data, String status, CoreSession session) Completes a task on a give node.
DocumentRoute	createNewInstance(DocumentRoute model, List<String> documentIds, CoreSession session) Deprecated. since 5.6, use other APIs
DocumentRoute	createNewInstance(DocumentRoute model, List<String> documentIds, CoreSession session, boolean startInstance) Create a new DocumentRoute instance from this DocumentRoute model.
DocumentRoute	createNewInstance(DocumentRoute model, String documentId, CoreSession session) Deprecated. since 5.6, use other APIs
DocumentRoute	createNewInstance(DocumentRoute model, String documentId, CoreSession session, boolean startInstance) Deprecated. since 5.6, use other APIs
String	createNewInstance(String routeModelId, List<String> docIds, CoreSession session, boolean startInstance) Creates a new route instance and optionally starts it.
String	createNewInstance(String routeModelId, List<String> docIds, Map<String,Serializable> map, CoreSession session, boolean startInstance) Creates a new route instance and optionally starts it.
void	delegateTask(CoreSession session, String taskId, List<String> delegatedActors, String comment) Reassigns the given task to the list of actors.
int	doCleanupDoneAndCanceledRouteInstances(String reprositoryName, int limit) Query for the routes 'done' or 'canceled' and delete them.
void	endTask(CoreSession session, Task task, Map<String,Object> data, String status) Ends a task.
void	finishTask(CoreSession session, DocumentRoute route, Task task, boolean delete) Deprecated. // will be removed in 5.8, use completeTask instead
List<DocumentRoute>	getAvailableDocumentRoute(CoreSession session) Return the list of available DocumentRoute document route.
List<DocumentRoute>	getAvailableDocumentRouteModel(CoreSession session) Return the list of available DocumentRoute model the user can start.
List<DocumentRoute>	getDocumentRelatedWorkflows(DocumentModel document, CoreSession session)
List<DocumentRoute>	getDocumentRoutesForAttachedDocument(CoreSession session, String attachedDocId)
List<DocumentRoute>	getDocumentRoutesForAttachedDocument(CoreSession session, String attachedDocId, List<DocumentRouteElement.ElementLifeCycleState> states) Return the list of related DocumentRoute in a state for a given attached document.
String	getOperationChainId(String documentType) Deprecated. since 5.9.2 - Use only routes of type 'graph'
DocumentModelList	getOrderedRouteElement(String routeElementId, CoreSession session) Deprecated. since 5.9.2 - Use only routes of type 'graph'
List<DocumentRouteTableElement>	getRouteElements(DocumentRoute route, CoreSession session) Computes the list of elements DocumentRouteTableElement for this DocumentRoute.
String	getRouteModelDocIdWithId(CoreSession session, String id) Returns the doc id of the route model with the given id
List<URL>	getRouteModelTemplateResources() Returns all the route models resource templates.
DocumentRoute	getRouteModelWithId(CoreSession session, String id) Returns the route model with the given id
List<DocumentRoute>	getRunningWorkflowInstancesLaunchedByCurrentUser(CoreSession session)
List<DocumentRoute>	getRunningWorkflowInstancesLaunchedByCurrentUser(CoreSession session, String worflowModelName)
List<Task>	getTasks(DocumentModel document, String actorId, String workflowInstanceId, String workflowModelName, CoreSession session)
String	getUndoFromDoneOperationChainId(String documentType) Return the operation chain to undo a step when the step is in done state.
String	getUndoFromRunningOperationChainId(String documentType) Deprecated. since 5.9.2 - Use only routes of type 'graph'
List<DocumentModel>	getWorkflowInputDocuments(CoreSession session, Task task) Gets the documents following the workflow to which the given task belongs
void	grantPermissionToTaskAssignees(CoreSession session, String permission, List<DocumentModel> docs, Task task) Grants on these documents the specified assignees permissions for this task.
void	grantPermissionToTaskDelegatedActors(CoreSession session, String permission, List<DocumentModel> docs, Task task) Grants on these documents the specified assignees permissions for this task to the tasks delegated actors.
DocumentRoute	importRouteModel(URL templateResource, boolean overwrite, CoreSession session) Creates a route model in the root models folder defined by the current persister.
void	invalidateRouteModelsCache()
boolean	isLockedByCurrentUser(DocumentRoute routeModel, CoreSession session) Verify is this DocumentRoute is already locked by the current user.
boolean	isRoutable(DocumentModel doc) Checks if the given document can be associated to a DocumentRoute.
boolean	isWorkflowModel(DocumentRoute documentRoute) Returns true id the document route is a model, false if it is just an instance i.e.
void	lockDocumentRoute(DocumentRoute routeModel, CoreSession session) Locks this DocumentRoute if not already locked by the current user.
void	makeRoutingTasks(CoreSession session, List<Task> tasks) Deprecated. The facet RoutingTask is statically attached to the new RoutingTask Document type since 7.1
void	reassignTask(CoreSession session, String taskId, List<String> actors, String comment) Reassigns the given task to the list of actors.
void	registerRouteResource(RouteModelResourceType resource, RuntimeContext extensionContext) Registers a new route model template to be imported at application startup.
void	removePermissionFromTaskAssignees(CoreSession session, List<DocumentModel> docs, Task task) Removes on these documents the specified assignees permissions for this task.
void	removePermissionsForTaskActors(CoreSession session, List<DocumentModel> docs, Task task) Removes on these documents the specified assignees permissions for the task actors and also tasks delegated actors if this task was delegated
void	removeRouteElement(DocumentRouteElement routeElement, CoreSession session) Deprecated. since 5.9.2 - Use only routes of type 'graph'
void	resumeInstance(String routeId, String nodeId, Map<String,Object> data, String status, CoreSession session) Resumes a route instance on a give node.
DocumentRoute	saveRouteAsNewModel(DocumentRoute route, CoreSession session) Save a route instance as a new model of route.
List<DocumentModel>	searchRouteModels(CoreSession session, String searchString) Returns the route models matching the searchString.
void	startInstance(String routeInstanceId, List<String> docIds, Map<String,Serializable> map, CoreSession session) Starts an instance that was created with 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.
void	unlockDocumentRoute(DocumentRoute routeModel, CoreSession session) Unlocks this DocumentRoute.If the document is not locked throws a DocumentRouteNotLockedException
DocumentRoute	unlockDocumentRouteUnrestrictedSession(DocumentRoute routeModel, CoreSession userSession) Unlock the given DocumentRoute model under unrestricted session.
void	updateRouteElement(DocumentRouteElement routeModel, CoreSession session) Update the given route element
DocumentRoute	validateRouteModel(DocumentRoute routeModel, CoreSession session) Validates the given DocumentRoute model by changing its lifecycle state and setting it and all its children in ReadOnly.

Method Detail

createNewInstance

String createNewInstance(String routeModelId,
                       List<String> docIds,
                       Map<String,Serializable> map,
                       CoreSession session,
                       boolean startInstance)

Creates a new route instance and optionally starts it.

If startInstance = false, then the route can be started later by calling startInstance(java.lang.String, java.util.List<java.lang.String>, java.util.Map<java.lang.String, java.io.Serializable>, org.nuxeo.ecm.core.api.CoreSession).

Parameters:

routeModelId - the route model id

docIds - the list of document bound to the instance

map - the values to pass as initial workflow variables

session - the session

startInstance - if the route is automatically started

Returns:

the created route instance id

createNewInstance

String createNewInstance(String routeModelId,
                       List<String> docIds,
                       CoreSession session,
                       boolean startInstance)

Creates a new route instance and optionally starts it.

If startInstance = false, then the route can be started later by calling startInstance(java.lang.String, java.util.List<java.lang.String>, java.util.Map<java.lang.String, java.io.Serializable>, org.nuxeo.ecm.core.api.CoreSession).

Parameters:

routeModelId - the route model id

docIds - The list of document bound to the instance.

session - the session

startInstance - if the route is automatically started

Returns:

the created route instance id

createNewInstance

DocumentRoute createNewInstance(DocumentRoute model,
                              List<String> documentIds,
                              CoreSession session,
                              boolean startInstance)

Create a new DocumentRoute instance from this DocumentRoute model.

Parameters:

model - The model used to create the instance.

documentIds - The list of document bound to the instance.

startInstance - if the DocumentRoute is automatically started.

Returns:

the created DocumentRoute instance.

createNewInstance

@Deprecated
DocumentRoute createNewInstance(DocumentRoute model,
                                         String documentId,
                                         CoreSession session,
                                         boolean startInstance)

Deprecated. since 5.6, use other APIs

createNewInstance

@Deprecated
DocumentRoute createNewInstance(DocumentRoute model,
                                         List<String> documentIds,
                                         CoreSession session)

Deprecated. since 5.6, use other APIs

createNewInstance

@Deprecated
DocumentRoute createNewInstance(DocumentRoute model,
                                         String documentId,
                                         CoreSession session)

Deprecated. since 5.6, use other APIs

startInstance

void startInstance(String routeInstanceId,
                 List<String> docIds,
                 Map<String,Serializable> map,
                 CoreSession session)

Starts an instance that was created with 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.

Parameters:

routeInstanceId - the route instance id

docIds - the list of document bound to the instance

map - the values to pass as initial workflow variables

session - the session

Since:

5.7.2

resumeInstance

void resumeInstance(String routeId,
                  String nodeId,
                  Map<String,Object> data,
                  String status,
                  CoreSession session)

Resumes a route instance on a give node. Any remaining tasks on this node will be cancelled.

Called by the UI action corresponding to a task button.

Parameters:

routeId - the id of the route instance

nodeId - the node id to resume on

data - the data coming from UI form

status - the status coming from UI form

session - the session

Since:

5.6

completeTask

void completeTask(String routeId,
                String taskId,
                Map<String,Object> data,
                String status,
                CoreSession session)

Completes a task on a give node. If this is the last task the workflow will continue.

Called by the UI action corresponding to a task button.

Parameters:

routeId - the id of the route instance

taskId - the id of the task

data - the data coming from UI form

status - the status coming from UI form

session - the session

Since:

5.6

saveRouteAsNewModel

DocumentRoute saveRouteAsNewModel(DocumentRoute route,
                                CoreSession session)

Save a route instance as a new model of route.

The place in which the new instance is persisted and its name depends on DocumentRoutingPersister. The route instance should be in either running, done or ready state. The new route model will be in draft state and won't have any attached documents.

Parameters:

route - the instance from which we create a new model.

Returns:

the new model in draft state.

getAvailableDocumentRouteModel

List<DocumentRoute> getAvailableDocumentRouteModel(CoreSession session)

Return the list of available DocumentRoute model the user can start.

Parameters:

session - The session of the user.

Returns:

A list of available DocumentRoute

getAvailableDocumentRoute

List<DocumentRoute> getAvailableDocumentRoute(CoreSession session)

Return the list of available DocumentRoute document route.

Parameters:

session - The session of the user.

Returns:

A list of available DocumentRoute

Since:

7.2

getOperationChainId

@Deprecated
String getOperationChainId(String documentType)

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Return the operation chain to run for a documentType. The document type should extend the DocumentRouteStep. Use the chainsToType extension point to contribute new mapping.

Parameters:

documentType - The document type

Returns:

The operation chain id.

getUndoFromRunningOperationChainId

@Deprecated
String getUndoFromRunningOperationChainId(String documentType)

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Return the operation chain to undo a step when the step is in running state. The document type should extend the DocumentRouteStep. Use the chainsToType extension point to contribute new mapping.

Parameters:

documentType -

Returns:

getUndoFromDoneOperationChainId

String getUndoFromDoneOperationChainId(String documentType)

Return the operation chain to undo a step when the step is in done state. The document type should extend the DocumentRouteStep. Use the chainsToType extension point to contribute new mapping.

Parameters:

documentType -

Returns:

validateRouteModel

DocumentRoute validateRouteModel(DocumentRoute routeModel,
                               CoreSession session)
                                 throws DocumentRouteNotLockedException,
                                        ClientException

Validates the given DocumentRoute model by changing its lifecycle state and setting it and all its children in ReadOnly.

Returns:

The validated route.

Throws:

DocumentRouteNotLockedException

ClientException

unlockDocumentRouteUnrestrictedSession

DocumentRoute unlockDocumentRouteUnrestrictedSession(DocumentRoute routeModel,
                                                   CoreSession userSession)
                                                     throws ClientException

Unlock the given DocumentRoute model under unrestricted session.

Parameters:

routeModel -

userSession -

Returns:

The unlocked route.

Throws:

ClientException

Since:

1.9

getRouteElements

List<DocumentRouteTableElement> getRouteElements(DocumentRoute route,
                                               CoreSession session)

Computes the list of elements DocumentRouteTableElement for this DocumentRoute.

Parameters:

routeDocument - DocumentRoute.

session - The session used to query the DocumentRoute.

A - list of DocumentRouteElement

getDocumentRoutesForAttachedDocument

List<DocumentRoute> getDocumentRoutesForAttachedDocument(CoreSession session,
                                                       String attachedDocId,
                                                       List<DocumentRouteElement.ElementLifeCycleState> states)

Return the list of related DocumentRoute in a state for a given attached document.

Parameters:

session - The session used to query the DocumentRoute.

states - the list of states.

Returns:

A list of available DocumentRoute

getDocumentRoutesForAttachedDocument

List<DocumentRoute> getDocumentRoutesForAttachedDocument(CoreSession session,
                                                       String attachedDocId)

Parameters:

session -

attachedDocId -

Returns:

See Also:

for route running or ready.

canUserValidateRoute

@Deprecated
boolean canUserValidateRoute(NuxeoPrincipal currentUser)

Deprecated. use canValidateRoute(DocumentModel, CoreSession) instead.

if the user can validate a route.

canValidateRoute

boolean canValidateRoute(DocumentModel documentRoute,
                       CoreSession coreSession)
                         throws ClientException

Checks if the principal that created the client session can validate the route

Parameters:

documentRoute -

coreSession -

Throws:

ClientException

addRouteElementToRoute

@Deprecated
void addRouteElementToRoute(DocumentRef parentDocumentRef,
                                     int idx,
                                     DocumentRouteElement routeElement,
                                     CoreSession session)
                            throws DocumentRouteNotLockedException,
                                   ClientException

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Add a route element in another route element.

Parameters:

parentDocumentRef - The DocumentRef of the parent document.

idx - The position of the document in its container.

routeElement - The document to add.

session -

Throws:

ClientException

DocumentRouteNotLockedException

addRouteElementToRoute

@Deprecated
void addRouteElementToRoute(DocumentRef parentDocumentRef,
                                     String sourceName,
                                     DocumentRouteElement routeElement,
                                     CoreSession session)
                            throws DocumentRouteNotLockedException,
                                   ClientException

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Add a route element in another route element.

If the parent element is in draft state, the routeElement is kept in draft state. Otherwise, the element is set to 'ready' state.

Parameters:

parentDocumentRef - The DocumentRef of the parent document.

sourceName - the name of the previous document in the container.

routeElement - the document to add.

session -

Throws:

ClientException

DocumentRouteNotLockedException

removeRouteElement

@Deprecated
void removeRouteElement(DocumentRouteElement routeElement,
                                 CoreSession session)
                        throws DocumentRouteNotLockedException,
                               ClientException

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Remove the given route element

Parameters:

The - route element document.

session -

Throws:

ClientException

DocumentRouteNotLockedException

getOrderedRouteElement

@Deprecated
DocumentModelList getOrderedRouteElement(String routeElementId,
                                                  CoreSession session)
                                         throws ClientException

Deprecated. since 5.9.2 - Use only routes of type 'graph'

Get the children of the given stepFolder ordered by the ecm:pos metadata.

Parameters:

stepFolderId -

session -

Returns:

Throws:

ClientException

lockDocumentRoute

void lockDocumentRoute(DocumentRoute routeModel,
                     CoreSession session)
                       throws DocumentRouteAlredayLockedException,
                              ClientException

Locks this DocumentRoute if not already locked by the current user. If the document is already locked by another user and DocumentRouteAlredayLockedException is thrown

Parameters:

routeDocument - DocumentRoute.

session - The session used to lock the DocumentRoute.

Throws:

ClientException

{@link - DocumentRouteAlredayLockedException}

DocumentRouteAlredayLockedException

unlockDocumentRoute

void unlockDocumentRoute(DocumentRoute routeModel,
                       CoreSession session)
                         throws DocumentRouteNotLockedException,
                                ClientException

Unlocks this DocumentRoute.If the document is not locked throws a DocumentRouteNotLockedException

Parameters:

routeDocument - DocumentRoute.

session - The session used to lock the DocumentRoute.

Throws:

{@link - ClientException}

DocumentRouteNotLockedException

ClientException

updateRouteElement

void updateRouteElement(DocumentRouteElement routeModel,
                      CoreSession session)
                        throws DocumentRouteNotLockedException,
                               ClientException

Update the given route element

Parameters:

The - route element document.

session -

Throws:

ClientException

DocumentRouteNotLockedException

isLockedByCurrentUser

boolean isLockedByCurrentUser(DocumentRoute routeModel,
                            CoreSession session)
                              throws ClientException

Verify is this DocumentRoute is already locked by the current user.

Parameters:

routeDocument - DocumentRoute.

session -

Throws:

ClientException

isRoutable

boolean isRoutable(DocumentModel doc)

Checks if the given document can be associated to a DocumentRoute.

Parameters:

doc - the document

Returns:

true if the document can be routed

importRouteModel

DocumentRoute importRouteModel(URL templateResource,
                             boolean overwrite,
                             CoreSession session)
                               throws ClientException

Creates a route model in the root models folder defined by the current persister. The templateResource is a zip tree xml export of a route document and it is imported using the core-io importer.

Parameters:

templateResource -

overwrite -

session -

Throws:

ClientException

Since:

5.6

registerRouteResource

void registerRouteResource(RouteModelResourceType resource,
                         RuntimeContext extensionContext)

Registers a new route model template to be imported at application startup.

Parameters:

resource - the resource

Since:

5.6

getRouteModelTemplateResources

List<URL> getRouteModelTemplateResources()
                                         throws ClientException

Returns all the route models resource templates. Use the routeModelImporter extension point to contribute new resources.

Throws:

ClientException

Since:

5.6

searchRouteModels

List<DocumentModel> searchRouteModels(CoreSession session,
                                    String searchString)
                                      throws ClientException

Returns the route models matching the searchString.

Throws:

ClientException

Since:

5.6

getRouteModelWithId

DocumentRoute getRouteModelWithId(CoreSession session,
                                String id)
                                  throws ClientException

Returns the route model with the given id

Throws:

ClientException

Since:

5.6

getRouteModelDocIdWithId

String getRouteModelDocIdWithId(CoreSession session,
                              String id)
                                throws ClientException

Returns the doc id of the route model with the given id

Throws:

ClientException

Since:

5.7

makeRoutingTasks

@Deprecated
void makeRoutingTasks(CoreSession session,
                               List<Task> tasks)
                      throws ClientException

Deprecated. The facet RoutingTask is statically attached to the new RoutingTask Document type since 7.1

Marks the tasks as Routing tasks.

This allows the related documents to be adapted to RoutingTask.

Parameters:

session - the session

tasks - the tasks

Throws:

ClientException

Since:

5.6, was on RoutingTaskService before

endTask

void endTask(CoreSession session,
           Task task,
           Map<String,Object> data,
           String status)
             throws ClientException

Ends a task. If this is the last task the workflow will continue.

Parameters:

session -

task -

data -

status - name of the button clicked to submit the task form

Throws:

ClientException

Since:

5.6, was on RoutingTaskService before

grantPermissionToTaskAssignees

void grantPermissionToTaskAssignees(CoreSession session,
                                  String permission,
                                  List<DocumentModel> docs,
                                  Task task)
                                    throws ClientException

Grants on these documents the specified assignees permissions for this task.

Parameters:

session - the session

permission - the permission

docs - the documents

task - the task

Throws:

ClientException

Since:

5.6

removePermissionFromTaskAssignees

void removePermissionFromTaskAssignees(CoreSession session,
                                     List<DocumentModel> docs,
                                     Task task)
                                       throws ClientException

Removes on these documents the specified assignees permissions for this task.

Parameters:

session - the session

docs - the documents

task - the task

Throws:

ClientException

Since:

5.6

getWorkflowInputDocuments

List<DocumentModel> getWorkflowInputDocuments(CoreSession session,
                                            Task task)
                                              throws ClientException

Gets the documents following the workflow to which the given task belongs

Parameters:

session -

task -

Returns:

Throws:

ClientException

Since:

5.6, was on RoutingTaskService before

finishTask

void finishTask(CoreSession session,
              DocumentRoute route,
              Task task,
              boolean delete)
                throws DocumentRouteException

Deprecated. // will be removed in 5.8, use completeTask instead

Finishes an open task. All permissions granted to the tasks assignees on the document following the worklflow are removed. Doesn't resume the workflow as the completeTask method. Not executed using an unrestricted session.

Parameters:

session -

route -

task -

delete -

Throws:

DocumentRouteException

Since:

5.7

cancelTask

void cancelTask(CoreSession session,
              String taskId)
                throws DocumentRouteException

Cancels an open task. If the task was created by an workflow, all permissions granted to the tasks assignees on the document following the worklflow are removed. Doesn't resume the workflow as the completeTask method.

Parameters:

session -

task -

delete -

Throws:

DocumentRouteException

Since:

5.7.3

reassignTask

void reassignTask(CoreSession session,
                String taskId,
                List<String> actors,
                String comment)
                  throws DocumentRouteException

Reassigns the given task to the list of actors. Removes the permissions granted on the document following the workflow to the current task assignees and grants them to the new actors.

Parameters:

session -

taskId -

actors -

comment -

Throws:

DocumentRouteException

Since:

5.7.3

delegateTask

void delegateTask(CoreSession session,
                String taskId,
                List<String> delegatedActors,
                String comment)
                  throws DocumentRouteException

Reassigns the given task to the list of actors. Grants to new delegated actors the same permissions as the task assignees on the document following the workflow .

Parameters:

session -

taskId -

delegatedActors -

comment -

Throws:

DocumentRouteException

Since:

5.8

grantPermissionToTaskDelegatedActors

void grantPermissionToTaskDelegatedActors(CoreSession session,
                                        String permission,
                                        List<DocumentModel> docs,
                                        Task task)
                                          throws ClientException

Grants on these documents the specified assignees permissions for this task to the tasks delegated actors.

Parameters:

session - the session

permission - the permission

docs - the documents

task - the task

Throws:

ClientException

Since:

5.8

removePermissionsForTaskActors

void removePermissionsForTaskActors(CoreSession session,
                                  List<DocumentModel> docs,
                                  Task task)
                                    throws ClientException

Removes on these documents the specified assignees permissions for the task actors and also tasks delegated actors if this task was delegated

Parameters:

session - the session

docs - the documents

task - the task

Throws:

ClientException

Since:

5.8

cleanupDoneAndCanceledRouteInstances

void cleanupDoneAndCanceledRouteInstances(String repositoryName,
                                        int limit)
                                          throws ClientException

Query for the routes 'done' or 'canceled' and delete them. The max no of the routes that will be deleted is specified by the 'limit' parameter. When the limit is '0' all the completed routes are deleted. The routes to be deleted are ordered ascending by their creation date.

Throws:

ClientException

Since:

5.8

invalidateRouteModelsCache

void invalidateRouteModelsCache()

Since:

5.9.3

doCleanupDoneAndCanceledRouteInstances

int doCleanupDoneAndCanceledRouteInstances(String reprositoryName,
                                         int limit)
                                           throws ClientException

Query for the routes 'done' or 'canceled' and delete them. The max no of the routes that will be deleted is specified by the 'limit' parameter. When the limit is '0' all the completed routes are deleted. The routes to be deleted are ordered ascending by their creation date.

Returns:

the number of cleaned up workflow instance

Throws:

ClientException

Since:

7.1

getTasks

List<Task> getTasks(DocumentModel document,
                  String actorId,
                  String workflowInstanceId,
                  String workflowModelName,
                  CoreSession session)

Parameters:

userId -

workflowInstanceId -

session -

Returns:

Since:

7.2

getDocumentRelatedWorkflows

List<DocumentRoute> getDocumentRelatedWorkflows(DocumentModel document,
                                              CoreSession session)

Parameters:

document -

session -

Returns:

Since:

7.2

getRunningWorkflowInstancesLaunchedByCurrentUser

List<DocumentRoute> getRunningWorkflowInstancesLaunchedByCurrentUser(CoreSession session)

Since:

7.2

getRunningWorkflowInstancesLaunchedByCurrentUser

List<DocumentRoute> getRunningWorkflowInstancesLaunchedByCurrentUser(CoreSession session,
                                                                   String worflowModelName)

Since:

7.2

isWorkflowModel

boolean isWorkflowModel(DocumentRoute documentRoute)

Returns true id the document route is a model, false if it is just an instance i.e. a running workflow.

Since:

7.2