public class LCStateImpl extends java.lang.Object implements LCState
Modifier and Type | Method and Description |
---|---|
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.
|
com.centrasite.lcmapi.LCState |
getGenericState()
Returns the generic com.centrasite.lcmapi.LCState wrapped by LCStateImpl.
|
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 criterion 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.
|
public com.centrasite.lcmapi.LCState getGenericState()
LCState
instancepublic java.lang.String getName() throws CSAppFrameworkException
LCState
getName
in interface LCState
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorpublic java.lang.String getDescription() throws CSAppFrameworkException
LCState
getDescription
in interface LCState
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorpublic java.util.Collection<LCState> getNextStates() throws CSAppFrameworkException
LCState
getNextStates
in interface LCState
Collection
of LCState
s, cannot be nullCSAppFrameworkException
- -
if the LCM provider encounters an internal errorpublic LCState getPreferredNexState() throws CSAppFrameworkException
LCState
getPreferredNexState
in interface LCState
LCState
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorpublic void setName(java.lang.String name) throws CSAppFrameworkException
LCState
setName
in interface LCState
name
- The name as StringCSAppFrameworkException
- -
if the LCM provider encounters an internal errorpublic void setDescription(java.lang.String description) throws CSAppFrameworkException
LCState
setDescription
in interface LCState
description
- Description to be setCSAppFrameworkException
- -
if the LCM provider encounters an internal errorpublic void addNextStates(java.util.Collection<LCState> nextStates) throws CSAppFrameworkException
LCState
addNextStates
in interface LCState
nextStates
- Collection
of LCState
s to be added as next statesCSAppFrameworkException
- -
if the LCM provider encounters an internal errorpublic void removeNextState(LCState nextState) throws CSAppFrameworkException
LCState
removeNextState
in interface LCState
nextState
- nextState LCState
object to removeCSAppFrameworkException
- -
if the LCM provider encounters an internal errorpublic void setPreferredNextState(LCState state) throws CSAppFrameworkException
LCState
setPreferredNextState
in interface LCState
state
- the preferred next sate for this LCStateCSAppFrameworkException
- if the given state is not currently assigned as a next statepublic boolean isTransitionAllowed() throws CSAppFrameworkException
LCState
isTransitionAllowed
in interface LCState
true
if the transition is allowed, false
otherwiseCSAppFrameworkException
- -
if the LCM provider encounters an internal errorpublic java.lang.String getStateConcept() throws CSAppFrameworkException
LCState
getStateConcept
in interface LCState
CSAppFrameworkException
- -
if the LCM provider encounters an internal error