com.softwareag.centrasite.appl.framework.lcm.beans
Interface LifeCycleAware

All Superinterfaces:
RegistryBean
All Known Subinterfaces:
LCAwareClassificationScheme, LCAwareRegistryEntry, LCAwareRegistryObject
All Known Implementing Classes:
LCAwareClassificationSchemeImpl, LCAwareDynamicRegistryBean, LCAwareRegistryEntryImpl, LCAwareRegistryObjectImpl

public interface LifeCycleAware
extends RegistryBean

Interface of an Life Cycle Aware object, which is stored or may be stored in the registry.


Method Summary
 void approveStateChange()
          Approves the state change
 LCModel findLCModel()
          Find the LCModel that is assigned to the registryBean
 LCRegistryObjectState getLCState()
          Returns the current state of the registryBean
 void rejectStateChange()
          Rejects the state change
 LCStateChangeStatus setLCState(LCState targetState)
          Set the registry bean to the given state
 
Methods inherited from interface com.softwareag.centrasite.appl.framework.beans.RegistryBean
getDescription, getKey, getName, setDescription, setName
 

Method Detail

getLCState

LCRegistryObjectState getLCState()
                                 throws CSAppFrameworkException
Returns the current state of the registryBean

Returns:
state as a LCRegistryObjectState, null if no state defined
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

setLCState

LCStateChangeStatus setLCState(LCState targetState)
                               throws CSAppFrameworkException
Set the registry bean to the given state

Parameters:
targetState - to which the registryBean is to be set
Returns:
LCStateChangeStatus with possible values LCStateChangeStatus.OK / LCStateChangeStatus.PENDING / LCStateChangeStatus.FAILED
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

approveStateChange

void approveStateChange()
                        throws CSAppFrameworkException
Approves the state change

Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

rejectStateChange

void rejectStateChange()
                       throws CSAppFrameworkException
Rejects the state change

Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

findLCModel

LCModel findLCModel()
                    throws CSAppFrameworkException
Find the LCModel that is assigned to the registryBean

Returns:
LCModel of the registryBean, null if no LCModel found
Throws:
CSAppFrameworkException - - If the LCM provider encounters an internal error