Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

alma::acs::component::ComponentStateManager Interface Reference

List of all members.

Public Member Functions

ComponentStates getCurrentState ()
void setState (ComponentStates newState) throws ComponentLifecycleException
String getName (ComponentStates corbaStateObj)

Detailed Description

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


Member Function Documentation

ComponentStates alma::acs::component::ComponentStateManager::getCurrentState  ) 
 

Returns the current state of the component

Returns:
the component's current state

String alma::acs::component::ComponentStateManager::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".

void alma::acs::component::ComponentStateManager::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
Exceptions:
ComponentLifecycleException if the transition from the current state to the new state is not allowed.


The documentation for this interface was generated from the following file:
Generated on Thu Apr 30 02:52:15 2009 for ACS Java API by doxygen 1.3.8