com.sodius.mdw.metamodel.rhapsody

Interface State

All Superinterfaces:

ModelElement, StateVertex

All Known Subinterfaces:

AcceptEventAction, AcceptTimeEvent, CallOperation, ObjectNode

public interface State
extends StateVertex

A representation of the model object 'State'.

The following features are supported:

• State Type
• Entry Action
• Exit Action
• Is Overridden
• Is Reference Activity
• Full Name In Statechart
• Is And
• Is Compound
• Is Leaf
• Is Root
• Nested Statechart
• Statechart
• Sub State Vertices
• Default Transition
• Reference To Activity
• Inherits From
• Logical States
• Static Reactions
• Sub States
• Send Action

See Also:

RhapsodyPackage.getState()

Method Summary

Modifier and Type	Method and Description
Transition	getDefaultTransition() Returns the value of the 'Default Transition' reference.
java.lang.String	getEntryAction() Returns the value of the 'Entry Action' attribute.
java.lang.String	getExitAction() Returns the value of the 'Exit Action' attribute.
java.lang.String	getFullNameInStatechart() Returns the value of the 'Full Name In Statechart' attribute.
State	getInheritsFrom() Returns the value of the 'Inherits From' reference.
MDWEList	getLogicalStates() Returns the value of the 'Logical States' reference list.
Statechart	getNestedStatechart() Returns the value of the 'Nested Statechart' reference.
ModelElement	getReferenceToActivity() Returns the value of the 'Reference To Activity' reference.
SendAction	getSendAction() Returns the value of the 'Send Action' reference.
Statechart	getStatechart() Returns the value of the 'Statechart' reference.
StateKind	getStateType() Returns the value of the 'State Type' attribute.
MDWEList	getStaticReactions() Returns the value of the 'Static Reactions' reference list.
MDWEList	getSubStates() Returns the value of the 'Sub States' reference list.
MDWEList	getSubStateVertices() Returns the value of the 'Sub State Vertices' reference list.
boolean	isAnd() Returns the value of the 'Is And' attribute.
boolean	isCompound() Returns the value of the 'Is Compound' attribute.
boolean	isLeaf() Returns the value of the 'Is Leaf' attribute.
boolean	isOverridden() Returns the value of the 'Is Overridden' attribute.
boolean	isReferenceActivity() Returns the value of the 'Is Reference Activity' attribute.
boolean	isRoot() Returns the value of the 'Is Root' attribute.
void	setDefaultTransition(Transition value) Sets the value of the 'Default Transition' reference.
void	setEntryAction(java.lang.String value) Sets the value of the 'Entry Action' attribute.
void	setExitAction(java.lang.String value) Sets the value of the 'Exit Action' attribute.
void	setFullNameInStatechart(java.lang.String value) Sets the value of the 'Full Name In Statechart' attribute.
void	setInheritsFrom(State value) Sets the value of the 'Inherits From' reference.
void	setIsAnd(boolean value) Sets the value of the 'Is And' attribute.
void	setIsCompound(boolean value) Sets the value of the 'Is Compound' attribute.
void	setIsLeaf(boolean value) Sets the value of the 'Is Leaf' attribute.
void	setIsOverridden(boolean value) Sets the value of the 'Is Overridden' attribute.
void	setIsReferenceActivity(boolean value) Sets the value of the 'Is Reference Activity' attribute.
void	setIsRoot(boolean value) Sets the value of the 'Is Root' attribute.
void	setNestedStatechart(Statechart value) Sets the value of the 'Nested Statechart' reference.
void	setReferenceToActivity(ModelElement value) Sets the value of the 'Reference To Activity' reference.
void	setSendAction(SendAction value) Sets the value of the 'Send Action' reference.
void	setStatechart(Statechart value) Sets the value of the 'Statechart' reference.
void	setStateType(StateKind value) Sets the value of the 'State Type' attribute.

Methods inherited from interface com.sodius.mdw.metamodel.rhapsody.StateVertex

getInTransitions, getOutTransitions, getParent, getSwimlane, setParent, setSwimlane

Methods inherited from interface com.sodius.mdw.metamodel.rhapsody.ModelElement

getAllTags, getAnnotations, getConstraints, getConstraintsByHim, getControlledFiles, getDependencies, getDescription, getDescriptionHTML, getDescriptionRTF, getDisplayName, getFullPathName, getGUID, getHyperLinks, getInterfaceName, getLocalTags, getMainDiagram, getMetaClass, getName, getOfTemplate, getOwnedDependencies, getOwner, getProject, getProperties, getProperty, getReferences, getStereotype, getStereotypes, getTemplateParameters, getTi, getUserDefinedMetaClass, isATemplate, isExternal, isRequirementTraceabilityHandle, isShowDisplayName, isUnresolved, setDescription, setDescriptionHTML, setDescriptionRTF, setDisplayName, setFullPathName, setGUID, setInterfaceName, setIsATemplate, setIsExternal, setIsShowDisplayName, setIsUnresolved, setMainDiagram, setMetaClass, setName, setOfTemplate, setOwner, setProject, setRequirementTraceabilityHandle, setStereotype, setTi, setUserDefinedMetaClass

Method Detail

getStateType

StateKind getStateType()

Returns the value of the 'State Type' attribute. The default value is "". The literals are from the enumeration StateKind.

Returns:

the value of the 'State Type' attribute.

See Also:

StateKind, setStateType(StateKind), RhapsodyPackage.getState_StateType()

setStateType

void setStateType(StateKind value)

Sets the value of the 'State Type' attribute.

Parameters:

value - the new value of the 'State Type' attribute.

See Also:

StateKind, getStateType()

getEntryAction

java.lang.String getEntryAction()

Returns the value of the 'Entry Action' attribute. The default value is "".

Returns:

the value of the 'Entry Action' attribute.

See Also:

setEntryAction(String), RhapsodyPackage.getState_EntryAction()

setEntryAction

void setEntryAction(java.lang.String value)

Sets the value of the 'Entry Action' attribute.

Parameters:

value - the new value of the 'Entry Action' attribute.

See Also:

getEntryAction()

getExitAction

java.lang.String getExitAction()

Returns the value of the 'Exit Action' attribute. The default value is "".

Returns:

the value of the 'Exit Action' attribute.

See Also:

setExitAction(String), RhapsodyPackage.getState_ExitAction()

setExitAction

void setExitAction(java.lang.String value)

Sets the value of the 'Exit Action' attribute.

Parameters:

value - the new value of the 'Exit Action' attribute.

See Also:

getExitAction()

isOverridden

boolean isOverridden()

Returns the value of the 'Is Overridden' attribute.

Returns:

the value of the 'Is Overridden' attribute.

See Also:

setIsOverridden(boolean), RhapsodyPackage.getState_IsOverridden()

setIsOverridden

void setIsOverridden(boolean value)

Sets the value of the 'Is Overridden' attribute.

Parameters:

value - the new value of the 'Is Overridden' attribute.

See Also:

isOverridden()

isReferenceActivity

boolean isReferenceActivity()

Returns the value of the 'Is Reference Activity' attribute.

Returns:

the value of the 'Is Reference Activity' attribute.

See Also:

setIsReferenceActivity(boolean), RhapsodyPackage.getState_IsReferenceActivity()

setIsReferenceActivity

void setIsReferenceActivity(boolean value)

Sets the value of the 'Is Reference Activity' attribute.

Parameters:

value - the new value of the 'Is Reference Activity' attribute.

See Also:

isReferenceActivity()

getFullNameInStatechart

java.lang.String getFullNameInStatechart()

Returns the value of the 'Full Name In Statechart' attribute. The default value is "".

Returns:

the value of the 'Full Name In Statechart' attribute.

See Also:

setFullNameInStatechart(String), RhapsodyPackage.getState_FullNameInStatechart()

setFullNameInStatechart

void setFullNameInStatechart(java.lang.String value)

Sets the value of the 'Full Name In Statechart' attribute.

Parameters:

value - the new value of the 'Full Name In Statechart' attribute.

See Also:

getFullNameInStatechart()

isAnd

boolean isAnd()

Returns the value of the 'Is And' attribute.

Returns:

the value of the 'Is And' attribute.

See Also:

setIsAnd(boolean), RhapsodyPackage.getState_IsAnd()

setIsAnd

void setIsAnd(boolean value)

Sets the value of the 'Is And' attribute.

Parameters:

value - the new value of the 'Is And' attribute.

See Also:

isAnd()

isCompound

boolean isCompound()

Returns the value of the 'Is Compound' attribute.

Returns:

the value of the 'Is Compound' attribute.

See Also:

setIsCompound(boolean), RhapsodyPackage.getState_IsCompound()

setIsCompound

void setIsCompound(boolean value)

Sets the value of the 'Is Compound' attribute.

Parameters:

value - the new value of the 'Is Compound' attribute.

See Also:

isCompound()

isLeaf

boolean isLeaf()

Returns the value of the 'Is Leaf' attribute.

Returns:

the value of the 'Is Leaf' attribute.

See Also:

setIsLeaf(boolean), RhapsodyPackage.getState_IsLeaf()

setIsLeaf

void setIsLeaf(boolean value)

Sets the value of the 'Is Leaf' attribute.

Parameters:

value - the new value of the 'Is Leaf' attribute.

See Also:

isLeaf()

isRoot

boolean isRoot()

Returns the value of the 'Is Root' attribute.

Returns:

the value of the 'Is Root' attribute.

See Also:

setIsRoot(boolean), RhapsodyPackage.getState_IsRoot()

setIsRoot

void setIsRoot(boolean value)

Sets the value of the 'Is Root' attribute.

Parameters:

value - the new value of the 'Is Root' attribute.

See Also:

isRoot()

getNestedStatechart

Statechart getNestedStatechart()

Returns the value of the 'Nested Statechart' reference.

Returns:

the value of the 'Nested Statechart' reference.

See Also:

setNestedStatechart(Statechart), RhapsodyPackage.getState_NestedStatechart()

setNestedStatechart

void setNestedStatechart(Statechart value)

Sets the value of the 'Nested Statechart' reference.

Parameters:

value - the new value of the 'Nested Statechart' reference.

See Also:

getNestedStatechart()

getStatechart

Statechart getStatechart()

Returns the value of the 'Statechart' reference.

Returns:

the value of the 'Statechart' reference.

See Also:

setStatechart(Statechart), RhapsodyPackage.getState_Statechart()

setStatechart

void setStatechart(Statechart value)

Sets the value of the 'Statechart' reference.

Parameters:

value - the new value of the 'Statechart' reference.

See Also:

getStatechart()

getSubStateVertices

MDWEList getSubStateVertices()

Returns the value of the 'Sub State Vertices' reference list. The list contents are of type StateVertex. It is bidirectional and its opposite is 'Parent'.

Returns:

the value of the 'Sub State Vertices' reference list.

See Also:

RhapsodyPackage.getState_SubStateVertices(), StateVertex.getParent()

getDefaultTransition

Transition getDefaultTransition()

Returns the value of the 'Default Transition' reference.

Returns:

the value of the 'Default Transition' reference.

See Also:

setDefaultTransition(Transition), RhapsodyPackage.getState_DefaultTransition()

setDefaultTransition

void setDefaultTransition(Transition value)

Sets the value of the 'Default Transition' reference.

Parameters:

value - the new value of the 'Default Transition' reference.

See Also:

getDefaultTransition()

getReferenceToActivity

ModelElement getReferenceToActivity()

Returns the value of the 'Reference To Activity' reference.

Returns:

the value of the 'Reference To Activity' reference.

See Also:

setReferenceToActivity(ModelElement), RhapsodyPackage.getState_ReferenceToActivity()

setReferenceToActivity

void setReferenceToActivity(ModelElement value)

Sets the value of the 'Reference To Activity' reference.

Parameters:

value - the new value of the 'Reference To Activity' reference.

See Also:

getReferenceToActivity()

getInheritsFrom

State getInheritsFrom()

Returns the value of the 'Inherits From' reference.

Returns:

the value of the 'Inherits From' reference.

See Also:

setInheritsFrom(State), RhapsodyPackage.getState_InheritsFrom()

setInheritsFrom

void setInheritsFrom(State value)

Sets the value of the 'Inherits From' reference.

Parameters:

value - the new value of the 'Inherits From' reference.

See Also:

getInheritsFrom()

getLogicalStates

MDWEList getLogicalStates()

Returns the value of the 'Logical States' reference list. The list contents are of type State.

Returns:

the value of the 'Logical States' reference list.

See Also:

RhapsodyPackage.getState_LogicalStates()

getStaticReactions

MDWEList getStaticReactions()

Returns the value of the 'Static Reactions' reference list. The list contents are of type Transition.

Returns:

the value of the 'Static Reactions' reference list.

See Also:

RhapsodyPackage.getState_StaticReactions()

getSubStates

MDWEList getSubStates()

Returns the value of the 'Sub States' reference list. The list contents are of type State.

Returns:

the value of the 'Sub States' reference list.

See Also:

RhapsodyPackage.getState_SubStates()

getSendAction

SendAction getSendAction()

Returns the value of the 'Send Action' reference.

Returns:

the value of the 'Send Action' reference.

See Also:

setSendAction(SendAction), RhapsodyPackage.getState_SendAction()

setSendAction

void setSendAction(SendAction value)

Sets the value of the 'Send Action' reference.

Parameters:

value - the new value of the 'Send Action' reference.

See Also:

getSendAction()