com.softwareag.centrasite.appl.framework.lcm
Interface LCState

All Known Subinterfaces:
LCRegistryObjectState
All Known Implementing Classes:
LCRegistryObjectStateImpl, LCStateImpl

public interface LCState

The LCState provides access to the LCState and state specific operations.


Method Summary
 void addNextStates(java.util.Collection<LCState> nextStates)
          Adds the given collection of states as next states to this LCState
 java.lang.String getDescription()
          Returns the description of this LCState
 java.lang.String getName()
          Returns the name of this LCState
 java.util.Collection<LCState> getNextStates()
          Returns the next states of this LCState
 LCState getPreferredNexState()
          Returns the preferred next state to this LCState
 java.lang.String getStateConcept()
          Returns the underlying State Concept key
 boolean isTransitionAllowed()
          Checks if the current logged in user has the sufficient permissions that match restriction criteriion of the state transition
 void removeNextState(LCState nextState)
          Removes the given state as next state to this LCState
 void setDescription(java.lang.String description)
          Sets the description for the LCState
 void setName(java.lang.String name)
          Sets the name for the LCState
 void setPreferredNextState(LCState state)
          Sets the preferred next state for this LCState The LCState passed here should be one of the states added as a next state to this LCState via addNextStates() call
 

Method Detail

getName

java.lang.String getName()
                         throws CSAppFrameworkException
Returns the name of this LCState

Returns:
name of the LCState as String
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

getDescription

java.lang.String getDescription()
                                throws CSAppFrameworkException
Returns the description of this LCState

Returns:
description as String
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

getNextStates

java.util.Collection<LCState> getNextStates()
                                            throws CSAppFrameworkException
Returns the next states of this LCState

Returns:
the next states as a Collection, cannot be null
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

getPreferredNexState

LCState getPreferredNexState()
                             throws CSAppFrameworkException
Returns the preferred next state to this LCState

Returns:
preferred next state as LCState
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

setName

void setName(java.lang.String name)
             throws CSAppFrameworkException
Sets the name for the LCState

Parameters:
name - as String
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

setDescription

void setDescription(java.lang.String description)
                    throws CSAppFrameworkException
Sets the description for the LCState

Parameters:
description - to be set
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

addNextStates

void addNextStates(java.util.Collection<LCState> nextStates)
                   throws CSAppFrameworkException
Adds the given collection of states as next states to this LCState

Parameters:
nextStates - collection of states to be added as next states
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

removeNextState

void removeNextState(LCState nextState)
                     throws CSAppFrameworkException
Removes the given state as next state to this LCState

Parameters:
nextState - nextState LCState object
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

setPreferredNextState

void setPreferredNextState(LCState state)
                           throws CSAppFrameworkException
Sets the preferred next state for this LCState The LCState passed here should be one of the states added as a next state to this LCState via addNextStates() call

Parameters:
state - the preferred next sate for this LCState
Throws:
CSAppFrameworkException - if the given state is not currently assigned as a next state

isTransitionAllowed

boolean isTransitionAllowed()
                            throws CSAppFrameworkException
Checks if the current logged in user has the sufficient permissions that match restriction criteriion of the state transition

Returns:
true if the transition is allowed, false otherwise
Throws:
CSAppFrameworkException - - if the LCM provider encounters an inernal error

getStateConcept

java.lang.String getStateConcept()
                                 throws CSAppFrameworkException
Returns the underlying State Concept key

Returns:
State concept key
Throws:
CSAppFrameworkException - - if the LCM provider encounters an inernal error