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

java.util.Collection<java.lang.String>	getAllowedStateTransitionsFrom(java.lang.String stateName) Gets the allowed state transitions from a given state.
java.lang.String	getDefaultInitialStateName() Returns the default initial state name.
java.util.Collection<java.lang.String>	getInitialStateNames() Returns the list of allowed initial state names.
java.lang.String	getName() Gets the life cycle name.
LifeCycleState	getStateByName(java.lang.String stateName) Returns a life cycle state instance given its name.
java.util.Collection<LifeCycleState>	getStates() Returns the list of life cycle state instances.
LifeCycleTransition	getTransitionByName(java.lang.String transitionName) Returns a life cycle transition instance given its name.
java.util.Collection<LifeCycleTransition>	getTransitions() Returns a list of life cycle transition instances.

Method Detail

getAllowedStateTransitionsFrom

java.util.Collection<java.lang.String> getAllowedStateTransitionsFrom(java.lang.String stateName)
                                                                      throws LifeCycleException

Gets the allowed state transitions from a given state.

Parameters:

stateName - the current state name

Returns:

collection of allowed state transition names.

Throws:

LifeCycleException

getDefaultInitialStateName

java.lang.String getDefaultInitialStateName()

Returns the default initial state name.

getInitialStateNames

java.util.Collection<java.lang.String> getInitialStateNames()

Returns the list of allowed initial state names.

getName

java.lang.String getName()

Gets the life cycle name.

Returns:

the life cycle name

getStateByName

LifeCycleState getStateByName(java.lang.String stateName)

Returns a life cycle state instance given its name.

Parameters:

stateName - the state name

Returns:

the life cycle state instance

getStates

java.util.Collection<LifeCycleState> getStates()

Returns the list of life cycle state instances.

Returns:

the list of life cycle state instances

getTransitionByName

LifeCycleTransition getTransitionByName(java.lang.String transitionName)

Returns a life cycle transition instance given its name.

Parameters:

transitionName - the transition name

Returns:

the life cycle transition instance

getTransitions

java.util.Collection<LifeCycleTransition> getTransitions()

Returns a list of life cycle transition instances.

Returns:

a list of life cycle transition instances.