com.softwareag.centrasite.api.csom
Interface LCMState

All Superinterfaces:
CentraSiteObject, CentraSiteRegistryObject

public interface LCMState
extends CentraSiteRegistryObject

LCMState is the state in the LCM state machine. It represent the state of the assigned instance type object. We can also enforce the policies on the state transition.


Method Summary
 java.util.Collection<LCMState> getAllowedNextStates()
          The next applicable state of registry object LCM ------------------------------------------------------------- | | | A --> B --> C --> D | | initial End | | | ------------------------------------------------------------- The above lcm model contains the states called A,B,C,D if the current state is B next allowed states are C
 LCMState getAllowedPreferredNextState()
          The next preferred state for the registry object.
 LCM getLCM()
          return LCM to which the state belongs.
 
Methods inherited from interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
getConsumers, getDescription, getDescription, getDisplayVersion, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPreviousVersion, getPreviousVersions, getRegistryObject, getSubscribers, getSystemVersion, getUserVersion, getVisiblePrimaryProfiles, isLatestVersionObject, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setUserVersion
 
Methods inherited from interface com.softwareag.centrasite.api.csom.CentraSiteObject
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, getType, isModified, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
 

Method Detail

getAllowedNextStates

java.util.Collection<LCMState> getAllowedNextStates()
                                                    throws CLLException
The next applicable state of registry object
 LCM
 -------------------------------------------------------------
 |                                                                                                                      |
 |     A --> B --> C --> D                                                                      |
 |   initial             End                                                                    |       
 |                                                                                                                      |
 -------------------------------------------------------------
 The above lcm model contains the states called A,B,C,D
 
 if the current state is B next allowed states are C
 
 

Returns:
next applicable states of registry object, in case the current LCMState is the last state then return null.
Throws:
CLLException - in case of failed to get the allowed next states.

getAllowedPreferredNextState

LCMState getAllowedPreferredNextState()
                                      throws CLLException
The next preferred state for the registry object.
 LCM
 -------------------------------------------------------------
 |                                                                                                                      |
 |     A --> B --> C --> D                                                                      |
 |   initial             End                                                                    |       
 |                                                                                                                      |
 -------------------------------------------------------------
 The above lcm model contains the states called A,B,C,D
 
 if the current state is B then prefered next state is C
 
 

Returns:
LCMState in case the current LCMState is the last state then return null.
Throws:
CLLException - in case of failed to get the preferred next state.

getLCM

LCM getLCM()
           throws CLLException
return LCM to which the state belongs.

Returns:
LCM
Throws:
CLLException - in case of failed to get the LCM.