alma.acs.component

Interface ComponentStateManager

All Known Implementing Classes:

ComponentStateManagerImpl

public interface ComponentStateManager

Author:

hsommer created Oct 22, 2003 5:07:57 PM

Method Summary

Modifier and Type	Method and Description
ComponentStates	getCurrentState() Returns the current state of the component
java.lang.String	getName(ComponentStates corbaStateObj) It seemed not worth it to create Java enum classes following the standard patterns, since the component has to return the CORBA state class anyway.
void	setState(ComponentStates newState) Requests to change the state.

Method Detail

getCurrentState

ComponentStates getCurrentState()

Returns the current state of the component

Returns:

the component's current state

setState

void setState(ComponentStates newState)
       throws ComponentLifecycleException

Requests to change the state. To be called only by the component (the container will use a separate method in the implementation class to allow for different transition validation rules)

Parameters:

newState - the new component state

Throws:

ComponentLifecycleException - if the transition from the current state to the new state is not allowed.

getName

java.lang.String getName(ComponentStates corbaStateObj)

It seemed not worth it to create Java enum classes following the standard patterns, since the component has to return the CORBA state class anyway. Nonetheless, getting the state names for logging etc. might be useful.

Parameters:

corbaStateObj - the int-based corba enum class

Returns:

the state name as specified in IDL, e.g. "COMPSTATE_NEW".