|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
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
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorLCState getPreferredNexState() throws CSAppFrameworkException
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorvoid setName(java.lang.String name) throws CSAppFrameworkException
name
- as String
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorvoid setDescription(java.lang.String description) throws CSAppFrameworkException
description
- to be set
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorvoid addNextStates(java.util.Collection<LCState> nextStates) throws CSAppFrameworkException
nextStates
- collection of states to be added as next states
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorvoid removeNextState(LCState nextState) throws CSAppFrameworkException
nextState
- nextState LCState object
CSAppFrameworkException
- -
if the LCM provider encounters an internal errorvoid setPreferredNextState(LCState state) throws CSAppFrameworkException
state
- the preferred next sate for this LCState
CSAppFrameworkException
- if the given state is not currently assigned as a next stateboolean isTransitionAllowed() throws CSAppFrameworkException
CSAppFrameworkException
- -
if the LCM provider encounters an inernal errorjava.lang.String getStateConcept() throws CSAppFrameworkException
CSAppFrameworkException
- -
if the LCM provider encounters an inernal error
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |