|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LifeCycleService
Life cycle service.
LifeCycleServiceImpl
Method Summary | |
---|---|
void |
followTransition(Document doc,
java.lang.String transitionName)
Follows a given transition. |
LifeCycle |
getLifeCycleByName(java.lang.String name)
Returns a life cycle given its name. |
LifeCycle |
getLifeCycleFor(Document doc)
Returns the life cycle a given document follows. |
java.lang.String |
getLifeCycleNameFor(java.lang.String typeName)
Returns the lifecycle name that the given type follows. |
java.util.Collection<LifeCycle> |
getLifeCycles()
Returns all the registered life cycles. |
java.util.List<java.lang.String> |
getNonRecursiveTransitionForDocType(java.lang.String docTypeName)
Returns a list of transition for which, when a it is followed, it should no recurse in its children. |
java.util.Collection<java.lang.String> |
getTypesFor(java.lang.String lifeCycleName)
Returns the types which follow a given life cycle. |
java.util.Map<java.lang.String,java.lang.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,
java.lang.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. |
Method Detail |
---|
void initialize(Document doc) throws LifeCycleException
Document state will be set to the life cycle initial state.
doc
- the document instance
LifeCycleException
void initialize(Document doc, java.lang.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 name
LifeCycleException
void followTransition(Document doc, java.lang.String transitionName) throws LifeCycleException
doc
- the Document instancetransitionName
- the transition name
LifeCycleException
LifeCycle getLifeCycleByName(java.lang.String name)
name
- the life cycle's name
java.util.Collection<LifeCycle> getLifeCycles()
java.util.Collection<java.lang.String> getTypesFor(java.lang.String lifeCycleName)
lifeCycleName
- a string holding the name of the life cycle
java.lang.String getLifeCycleNameFor(java.lang.String typeName)
typeName
- the type's name
java.util.List<java.lang.String> getNonRecursiveTransitionForDocType(java.lang.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 type
BulkLifeCycleChangeListener
java.util.Map<java.lang.String,java.lang.String> getTypesMapping()
LifeCycle getLifeCycleFor(Document doc)
doc
- the document instance
void reinitLifeCycle(Document doc) throws LifeCycleException
doc
-
LifeCycleException
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |