|
||||||||
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 Please make sure that this LC state is added to a LC model before adding next states. |
void |
addPromotionNodes(java.util.Collection<LCMNode> promotionNodes)
Adds the promotion node for this state. |
javax.xml.registry.infomodel.InternationalString |
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.util.Collection<LCMNode> |
getPromotionNodes()
Returns the promotion nodes |
java.util.Collection |
getRestrictedTo()
Returns the collection of user / role / group's for which the transition to this state is restricted. |
javax.xml.registry.infomodel.Concept |
getStateConcept()
Returns the underlying State Concept |
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 |
removePromotionNodes(java.util.Collection<LCMNode> promotionNodes)
remove the promotion node for this state. |
void |
restrictTo(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> restrictedFor)
Allows restricting the state transitions to particular users / roles / groups Note that calling this method will overwrite any existing restrictions for the state |
void |
setDescription(javax.xml.registry.infomodel.InternationalString 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 LCMException
LCMException
- - if the LCM provider encounters an internal errorjavax.xml.registry.infomodel.InternationalString getDescription() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorjava.util.Collection<LCState> getNextStates() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorLCState getPreferredNexState() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorjava.util.Collection<LCMNode> getPromotionNodes() throws LCMException
LCMException
- - if the LCM provider encounters an internal errorvoid setName(java.lang.String name) throws LCMException
name
- as String
LCMException
- - if the LCM provider encounters an internal errorvoid setDescription(javax.xml.registry.infomodel.InternationalString description) throws LCMException
description
- to be set
LCMException
- - if the LCM provider encounters an internal errorvoid addNextStates(java.util.Collection<LCState> nextStates) throws LCMException
nextStates
- collection of states to be added as next states
LCMException
- - if the LCM provider encounters an internal errorvoid addPromotionNodes(java.util.Collection<LCMNode> promotionNodes) throws LCMException
promotionNodes
- the promotion nodes as collection of LCMNode objects
LCMException
- - if the LCM provider encounters an internal errorvoid removePromotionNodes(java.util.Collection<LCMNode> promotionNodes) throws LCMException
promotionNodes
- the promotion nodes as collection of LCMNode objects
LCMException
- - if the LCM provider encounters an internal errorvoid removeNextState(LCState nextState) throws LCMException
nextState
- nextState LCState object
LCMException
- - if the LCM provider encounters an internal errorvoid setPreferredNextState(LCState state) throws LCMException
state
- the preferred next sate for this LCState
LCMException
- if the given state is not currently assigned as a next statevoid restrictTo(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> restrictedFor) throws LCMException
restrictedFor
- - should be a collection of User objects or a RegistryEntries that are classified
as group (OBJECT_TYPE_KEY_Group) or role (OBJECT_TYPE_KEY_ROLE)
LCMException
- - if the given registry object does not meet the above or
if the LCM provider encounters an inernal errorjava.util.Collection getRestrictedTo() throws LCMException
LCMException
- - If the LCM provider encounters an internal errorboolean isTransitionAllowed() throws LCMException
LCMException
- - if the LCM provider encounters an inernal errorjavax.xml.registry.infomodel.Concept getStateConcept() throws LCMException
LCMException
- - if the LCM provider encounters an inernal error
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |