public interface LCState
LCState
provides access to the LCState and state specific
operations.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.
|
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.
|
java.lang.String getName() throws CSAppFrameworkException
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorjava.lang.String getDescription() throws CSAppFrameworkException
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorjava.util.Collection<LCState> getNextStates() throws CSAppFrameworkException
Collection
of LCState
s, cannot be nullCSAppFrameworkException
- -
if the LCM provider encounters an internal errorLCState getPreferredNexState() throws CSAppFrameworkException
LCState
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorvoid setName(java.lang.String name) throws CSAppFrameworkException
name
- The name as StringCSAppFrameworkException
- -
if the LCM provider encounters an internal errorvoid setDescription(java.lang.String description) throws CSAppFrameworkException
description
- Description to be setCSAppFrameworkException
- -
if the LCM provider encounters an internal errorvoid addNextStates(java.util.Collection<LCState> nextStates) throws CSAppFrameworkException
nextStates
- Collection
of LCState
s to be added as next statesCSAppFrameworkException
- -
if the LCM provider encounters an internal errorvoid removeNextState(LCState nextState) throws CSAppFrameworkException
nextState
- nextState LCState
object to removeCSAppFrameworkException
- -
if the LCM provider encounters an internal errorvoid setPreferredNextState(LCState state) throws CSAppFrameworkException
state
- the preferred next sate for this LCStateCSAppFrameworkException
- if the given state is not currently assigned as a next stateboolean isTransitionAllowed() throws CSAppFrameworkException
true
if the transition is allowed, false
otherwiseCSAppFrameworkException
- -
if the LCM provider encounters an internal errorjava.lang.String getStateConcept() throws CSAppFrameworkException
CSAppFrameworkException
- -
if the LCM provider encounters an internal error