Package org.nuxeo.ecm.core.lifecycle
Interface LifeCycle
-
- All Known Implementing Classes:
LifeCycleImpl
public interface LifeCycle
Document life cycle.- Author:
- Julien Anguenot
- See Also:
LifeCycleImpl
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Collection<String>
getAllowedStateTransitionsFrom(String stateName)
Gets the allowed state transitions from a given state.String
getDefaultInitialStateName()
Returns the default initial state name.Collection<String>
getInitialStateNames()
Returns the list of allowed initial state names.String
getName()
Gets the life cycle name.LifeCycleState
getStateByName(String stateName)
Returns a life cycle state instance given its name.Collection<LifeCycleState>
getStates()
Returns the list of life cycle state instances.LifeCycleTransition
getTransitionByName(String transitionName)
Returns a life cycle transition instance given its name.Collection<LifeCycleTransition>
getTransitions()
Returns a list of life cycle transition instances.
-
-
-
Method Detail
-
getAllowedStateTransitionsFrom
Collection<String> getAllowedStateTransitionsFrom(String stateName)
Gets the allowed state transitions from a given state.- Parameters:
stateName
- the current state name- Returns:
- collection of allowed state transition names.
-
getDefaultInitialStateName
String getDefaultInitialStateName()
Returns the default initial state name.
-
getInitialStateNames
Collection<String> getInitialStateNames()
Returns the list of allowed initial state names.
-
getName
String getName()
Gets the life cycle name.- Returns:
- the life cycle name
-
getStateByName
LifeCycleState getStateByName(String stateName)
Returns a life cycle state instance given its name.- Parameters:
stateName
- the state name- Returns:
- the life cycle state instance
-
getStates
Collection<LifeCycleState> getStates()
Returns the list of life cycle state instances.- Returns:
- the list of life cycle state instances
-
getTransitionByName
LifeCycleTransition getTransitionByName(String transitionName)
Returns a life cycle transition instance given its name.- Parameters:
transitionName
- the transition name- Returns:
- the life cycle transition instance
-
getTransitions
Collection<LifeCycleTransition> getTransitions()
Returns a list of life cycle transition instances.- Returns:
- a list of life cycle transition instances.
-
-