org.nuxeo.ecm.platform.routing.api

Interface DocumentRoutingService

All Known Implementing Classes:

DocumentRoutingServiceImpl

public interface DocumentRoutingService

The DocumentRoutingService allows manipulate DocumentRoute.

Author:

arussel

Method Summary

Methods

Modifier and Type	Method and Description
void	addRouteElementToRoute(DocumentRef parentDocumentRef, int idx, DocumentRouteElement routeElement, CoreSession session) Add a route element in another route element.
void	addRouteElementToRoute(DocumentRef parentDocumentRef, String sourceName, DocumentRouteElement routeElement, CoreSession session) Add a route element in another route element.
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
DocumentRoute	createNewInstance(DocumentRoute model, List<String> documentIds, CoreSession session)
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)
DocumentRoute	createNewInstance(DocumentRoute model, String documentId, CoreSession session, boolean startInstance)
List<DocumentRoute>	getAvailableDocumentRouteModel(CoreSession session) Return the list of available DocumentRoute model the user can start.
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) Return the operation chain to run for a documentType.
DocumentModelList	getOrderedRouteElement(String routeElementId, CoreSession session) Get the children of the given stepFolder ordered by the ecm:pos metadata.
List<DocumentRouteTableElement>	getRouteElements(DocumentRoute route, CoreSession session) Computes the list of elements DocumentRouteTableElement for this DocumentRoute.
String	getUndoFromDoneOperationChainId(String documentType) Return the operation chain to undo a step when the step is in done state.
String	getUndoFromRunningOperationChainId(String documentType) Return the operation chain to undo a step when the step is in running state.
boolean	isLockedByCurrentUser(DocumentRoute routeModel, CoreSession session) Verify is this DocumentRoute is already locked by the current user.
void	lockDocumentRoute(DocumentRoute routeModel, CoreSession session) Locks this DocumentRoute if not already locked by the current user.
void	removeRouteElement(DocumentRouteElement routeElement, CoreSession session) Remove the given route element
DocumentRoute	saveRouteAsNewModel(DocumentRoute route, CoreSession session) Save a route instance as a new model of route.
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

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.

documents - The list of document bound to the instance.

startInstance - if the DocumentRoute is automatically started.

Returns:

the created DocumentRoute instance.

createNewInstance

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

See Also:

with only one document attached.

createNewInstance

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

See Also:

with startInstance true

createNewInstance

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

See Also:

with startInstance true and only one document attached.

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

getOperationChainId

String getOperationChainId(String documentType)

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

String getUndoFromRunningOperationChainId(String documentType)

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

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

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

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

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

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

Remove the given route element

Parameters:

The - route element document.

session -

Throws:

ClientException

DocumentRouteNotLockedException

getOrderedRouteElement

DocumentModelList getOrderedRouteElement(String routeElementId,
                                       CoreSession session)
                                         throws ClientException

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