public interface DocumentRouteElement extends Serializable
DocumentRoute
Modifier and Type | Interface and Description |
---|---|
static class |
DocumentRouteElement.ElementLifeCycleState
The lifecycle state of an element
|
static class |
DocumentRouteElement.ElementLifeCycleTransistion
The transition of the lifecycle state.
|
Modifier and Type | Method and Description |
---|---|
void |
backToReady(CoreSession session)
Set the step back to the ready state from running or done.
|
void |
cancel(CoreSession session)
Cancel this element.
|
boolean |
canDeleteStep(CoreSession session)
If this session can delete this step.
|
boolean |
canUndoStep(CoreSession session)
If this step can be undone.
|
boolean |
canUpdateStep(CoreSession session)
If this session can update this step.
|
boolean |
canValidateStep(CoreSession session)
If this session can validate the step.
|
void |
followTransition(DocumentRouteElement.ElementLifeCycleTransistion transition,
CoreSession session,
boolean recursive)
make this element follow a transition.
|
DocumentModelList |
getAttachedDocuments(CoreSession session)
Return the list of documents that this route processes.
|
String |
getDescription()
the description of this element.
|
DocumentModel |
getDocument()
Get the underlying document representing this element.
|
DocumentRoute |
getDocumentRoute(CoreSession session)
Return the DocumentRoute this element is part of.
|
String |
getName()
The name of this element.
|
String |
getTitle() |
boolean |
isCanceled() |
boolean |
isDone()
if this route is done.
|
boolean |
isDraft()
if this route is draft.
|
boolean |
isModifiable() |
boolean |
isReady()
if this element is ready.
|
boolean |
isRunning()
if this route is running.
|
boolean |
isValidated()
if the route this element is part of has been validated.
|
void |
resume(CoreSession session,
String nodeId,
String taskId,
Map<String,Object> data,
String status)
Resumes execution on a route node.
|
void |
run(CoreSession session)
Execute this element.
|
void |
run(CoreSession session,
Map<String,Serializable> map)
Execute this element.
|
void |
save(CoreSession session)
save the document representing this DocumentRoute.
|
void |
setCanceled(CoreSession session)
Set the step to a cancel step.
|
void |
setCanDeleteStep(CoreSession session,
String userOrGroup)
make this user or group step deleter.
|
void |
setCanReadStep(CoreSession session,
String userOrGroup)
make this user or group a step reader.
|
void |
setCanUpdateStep(CoreSession session,
String userOrGroup)
make this user or group a step updater.
|
void |
setCanValidateStep(CoreSession session,
String userOrGroup)
make this user or group a validator for this step.
|
void |
setDone(CoreSession session)
set this element as done.
|
void |
setReadOnly(CoreSession session)
remove write rights to everyone but the administrators.
|
void |
setReady(CoreSession session)
set this element as ready.
|
void |
setRunning(CoreSession session)
set this element as running.
|
void |
setValidated(CoreSession session)
set this element as validated.
|
void |
validate(CoreSession session)
Set this element to the validate state and put it in read only mode.
|
DocumentModelList getAttachedDocuments(CoreSession session)
session
- the session used to fetch the documentsDocumentRoute getDocumentRoute(CoreSession session)
session
- The session use to fetch the route.boolean isValidated()
boolean isReady()
boolean isDone()
boolean isRunning()
boolean isDraft()
String getDescription()
void run(CoreSession session)
session
- void run(CoreSession session, Map<String,Serializable> map)
session
- map
- the values to pass as initial workflow variablesvoid resume(CoreSession session, String nodeId, String taskId, Map<String,Object> data, String status)
session
- the sessionnodeId
- the node id to resume ontaskId
- the task iddata
- the data coming from UI formstatus
- the id of the button clicked to submit the related task formvoid validate(CoreSession session)
session
- DocumentModel getDocument()
void save(CoreSession session)
session
- void setValidated(CoreSession session)
void setReady(CoreSession session)
void setRunning(CoreSession session)
void setDone(CoreSession session)
void setReadOnly(CoreSession session)
void followTransition(DocumentRouteElement.ElementLifeCycleTransistion transition, CoreSession session, boolean recursive)
transition
- the followed transition.session
- the session used to follow the transition.recursive
- If this element has children, do we recurse the follow transition.BulkLifeCycleChangeListener
boolean canValidateStep(CoreSession session)
void setCanValidateStep(CoreSession session, String userOrGroup)
boolean canUpdateStep(CoreSession session)
void setCanUpdateStep(CoreSession session, String userOrGroup)
void setCanReadStep(CoreSession session, String userOrGroup)
boolean canDeleteStep(CoreSession session)
boolean canUndoStep(CoreSession session)
void setCanDeleteStep(CoreSession session, String userOrGroup)
void backToReady(CoreSession session)
void setCanceled(CoreSession session)
void cancel(CoreSession session)
session
- boolean isCanceled()
boolean isModifiable()
Copyright © 2017 Nuxeo. All rights reserved.