public interface LifeCycleService
LifeCycleServiceImpl
Modifier and Type | Method and Description |
---|---|
void |
followTransition(Document doc,
String transitionName)
Follows a given transition.
|
LifeCycle |
getLifeCycleByName(String name)
Returns a life cycle given its name.
|
LifeCycle |
getLifeCycleFor(Document doc)
Returns the life cycle a given document follows.
|
String |
getLifeCycleNameFor(String typeName)
Returns the lifecycle name that the given type follows.
|
Collection<LifeCycle> |
getLifeCycles()
Returns all the registered life cycles.
|
List<String> |
getNonRecursiveTransitionForDocType(String docTypeName)
Returns a list of transition for which, when a it is followed, it should no recurse in its children.
|
Collection<String> |
getTypesFor(String lifeCycleName)
Returns the types which follow a given life cycle.
|
Map<String,String> |
getTypesMapping()
Returns the mapping from types to life cycle names.
|
void |
initialize(Document doc)
Initializes the life cycle for the given document.
|
void |
initialize(Document doc,
String initialStateName)
Initializes the life cycle for the given document.
|
void |
reinitLifeCycle(Document doc)
Sets the current state to the initial state as defined by the associated lifecycle.
|
void initialize(Document doc) throws LifeCycleException
Document state will be set to the life cycle initial state.
doc
- the document instanceLifeCycleException
LifeCycleException
void initialize(Document doc, String initialStateName) throws LifeCycleException
Tries to set given state on document, if it's a valid initial state.
doc
- the document instanceinitialStateName
- the initial state nameLifeCycleException
LifeCycleException
void followTransition(Document doc, String transitionName) throws LifeCycleException
doc
- the Document instancetransitionName
- the transition nameLifeCycleException
LifeCycleException
LifeCycle getLifeCycleByName(String name)
name
- the life cycle's nameCollection<LifeCycle> getLifeCycles()
Collection<String> getTypesFor(String lifeCycleName)
lifeCycleName
- a string holding the name of the life cycleString getLifeCycleNameFor(String typeName)
typeName
- the type's nameList<String> getNonRecursiveTransitionForDocType(String docTypeName)
BulkLifeCycleChangeListener
will listen to the transition taken event and call a follow transition on the
children of the document if the document is folderish. It check this list of transition to find out if it should
recurse.docTypeName
- The doc typeBulkLifeCycleChangeListener
Map<String,String> getTypesMapping()
LifeCycle getLifeCycleFor(Document doc)
doc
- the document instancevoid reinitLifeCycle(Document doc) throws LifeCycleException
doc
- LifeCycleException
LifeCycleException
Copyright © 2018 Nuxeo. All rights reserved.