com.softwareag.centrasite.api.csom
Interface LCMStateAssignment


public interface LCMStateAssignment

LCMStateAssignment wraps the current state and pending of the CentraSiteObject.


Method Summary
 LCMState getCurrentState()
          currently assigned state of the registry object
 LCMState getLCMStateById(java.lang.String lcmIStateID)
           
 java.lang.String getName()
          return the LCMState label, in case the next state transition is in pending the label is enclosed with Pending i.e Pending(State)
 java.lang.String getName(java.util.Locale locale)
          return getName() specific to given locale.
 LCMState getPendingState()
          Pending state of the registry object in case that state is exists other wise return null.
 boolean isPending()
          used to find the registry object is pending state.
 

Method Detail

getName

java.lang.String getName()
                         throws CLLException
return the LCMState label, in case the next state transition is in pending the label is enclosed with Pending i.e Pending(State)

Returns:
CentraSiteRegistryObject.getName(), but in case next state transition is in pending then is enclosed with the text Pending( CentraSiteRegistryObject.getName())
Throws:
CLLException - in case of failed to get the Name.

getName

java.lang.String getName(java.util.Locale locale)
                         throws CLLException
return getName() specific to given locale.

Parameters:
locale - to which getName() value need to render.
Returns:
getName() for the
Throws:
CLLException - in case of failed to get the name for given locale

getCurrentState

LCMState getCurrentState()
                         throws CLLException
currently assigned state of the registry object

Returns:
LCMState or null if not match with the given ID
Throws:
CLLException - in case of failed to get the current assigned state.

getPendingState

LCMState getPendingState()
                         throws CLLException
Pending state of the registry object in case that state is exists other wise return null.

Returns:
LCMState
Throws:
CLLException - in case of failed to get the pending state.

getLCMStateById

LCMState getLCMStateById(java.lang.String lcmIStateID)
                         throws CLLException
Returns:
LCMState
Throws:
CLLException - in case of failed to get the LCM state by the given state ID.

isPending

boolean isPending()
used to find the registry object is pending state.

Returns:
true - in case registry object is in pending state other wise false.