com.nomagic.uml2.ext.magicdraw.statemachines.mdbehaviorstatemachines

Interface State

All Superinterfaces:

BaseElement, java.lang.Cloneable, java.lang.Comparable, Element, org.eclipse.emf.ecore.EObject, MDObject, ModelObject, NamedElement, Namespace, org.eclipse.emf.common.notify.Notifier, RedefinableElement, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, Vertex

All Known Subinterfaces:

FinalState

public interface State
extends Namespace, RedefinableElement, Vertex

A representation of the model object 'State'.

A State models a situation during which some (usually implicit) invariant condition holds.

The following features are supported:

• Region
• Connection Point
• Connection
• Submachine
• State Invariant
• Deferrable Trigger
• Do Activity
• Entry
• Exit
• Composite
• Orthogonal
• Simple
• Submachine State
• Redefined State
• state Of Redefined State
• object Node Of In State

See Also:

UMLPackage.getState()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<ObjectNode>	get_objectNodeOfInState() Returns the value of the 'object Node Of In State' reference list.
java.util.Collection<State>	get_stateOfRedefinedState() Returns the value of the 'state Of Redefined State' reference list.
java.util.Collection<ConnectionPointReference>	getConnection() Returns the value of the 'Connection' containment reference list.
java.util.Collection<Pseudostate>	getConnectionPoint() Returns the value of the 'Connection Point' containment reference list.
java.util.Collection<Trigger>	getDeferrableTrigger() Returns the value of the 'Deferrable Trigger' containment reference list.
Behavior	getDoActivity() Returns the value of the 'Do Activity' containment reference.
Behavior	getEntry() Returns the value of the 'Entry' containment reference.
Behavior	getExit() Returns the value of the 'Exit' containment reference.
State	getRedefinedState() Returns the value of the 'Redefined State' reference.
java.util.Collection<Classifier>	getRedefinitionContext() Returns the value of the 'Redefinition Context' reference list.
java.util.Collection<Region>	getRegion() Returns the value of the 'Region' containment reference list.
Constraint	getStateInvariant() Returns the value of the 'State Invariant' reference.
StateMachine	getSubmachine() Returns the value of the 'Submachine' reference.
boolean	has_objectNodeOfInState()
boolean	has_stateOfRedefinedState()
boolean	hasConnection()
boolean	hasConnectionPoint()
boolean	hasDeferrableTrigger()
boolean	hasRegion()
boolean	isComposite() Returns the value of the 'Composite' attribute.
boolean	isOrthogonal() Returns the value of the 'Orthogonal' attribute.
boolean	isSimple() Returns the value of the 'Simple' attribute.
boolean	isSubmachineState() Returns the value of the 'Submachine State' attribute.
void	setDoActivity(Behavior value) Sets the value of the 'Do Activity' containment reference.
void	setEntry(Behavior value) Sets the value of the 'Entry' containment reference.
void	setExit(Behavior value) Sets the value of the 'Exit' containment reference.
void	setRedefinedState(State value) Sets the value of the 'Redefined State' reference.
void	setStateInvariant(Constraint value) Sets the value of the 'State Invariant' reference.
void	setSubmachine(StateMachine value) Sets the value of the 'Submachine' reference.

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Namespace

getElementImport, getImportedMember, getMember, getOwnedDiagram, getOwnedMember, getOwnedRule, getPackageImport, hasElementImport, hasImportedMember, hasMember, hasOwnedDiagram, hasOwnedMember, hasOwnedRule, hasPackageImport

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.RedefinableElement

get_redefinableElementOfRedefinedElement, getRedefinedElement, has_redefinableElementOfRedefinedElement, hasRedefinedElement, hasRedefinitionContext, isLeaf, setLeaf

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.statemachines.mdbehaviorstatemachines.Vertex

getContainer, getIncoming, getOutgoing, hasIncoming, hasOutgoing, setContainer

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.NamedElement

get_considerIgnoreFragmentOfMessage, get_durationObservationOfEvent, get_informationFlowOfInformationSource, get_informationFlowOfInformationTarget, get_messageOfSignature, get_namespaceOfMember, get_timeObservationOfEvent, getClientDependency, getName, getNameExpression, getNamespace, getQualifiedName, getSupplierDependency, getVisibility, has_considerIgnoreFragmentOfMessage, has_durationObservationOfEvent, has_informationFlowOfInformationSource, has_informationFlowOfInformationTarget, has_messageOfSignature, has_namespaceOfMember, has_timeObservationOfEvent, hasClientDependency, hasSupplierDependency, setName, setNameExpression, setNamespace, setVisibility

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element

get_activityPartitionOfRepresents, get_commentOfAnnotatedElement, get_constraintOfConstrainedElement, get_diagramOfContext, get_directedRelationshipOfSource, get_directedRelationshipOfTarget, get_elementOfSyncElement, get_elementValueOfElement, get_relationshipOfRelatedElement, getAppliedStereotypeInstance, getOwnedComment, getOwnedElement, getOwner, getSyncElement, has_activityPartitionOfRepresents, has_commentOfAnnotatedElement, has_constraintOfConstrainedElement, has_diagramOfContext, has_directedRelationshipOfSource, has_directedRelationshipOfTarget, has_elementOfSyncElement, has_elementValueOfElement, has_relationshipOfRelatedElement, hasOwnedComment, hasOwnedElement, setAppliedStereotypeInstance, setOwner, setSyncElement

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.base.ModelObject

get_representationText, getLocalID, isInvalid, set_representationText, setLocalID, sGetLocalID

Methods inherited from interface com.nomagic.magicdraw.foundation.MDObject

getID, getMDExtension, getMdExtensions, setID

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.nomagic.magicdraw.uml.BaseElement

accept, addPropertyChangeListener, canAdd, canAdd, canAddChild, canBeDeleted, firePropertyChange, getClassType, getHumanName, getHumanType, getObjectParent, isEditable, removePropertyChangeListener, sGetID

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

getSubmachine

@CheckForNull
StateMachine getSubmachine()

Returns the value of the 'Submachine' reference. It is bidirectional and its opposite is 'Submachine State'. The StateMachine that is to be inserted in place of the (submachine) State.

Returns:

the value of the 'Submachine' reference.

See Also:

setSubmachine(StateMachine), UMLPackage.getState_Submachine(), StateMachine.getSubmachineState()

setSubmachine

void setSubmachine(@CheckForNull
                   StateMachine value)

Sets the value of the 'Submachine' reference.

Parameters:

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

See Also:

getSubmachine()

getConnection

java.util.Collection<ConnectionPointReference> getConnection()

Returns the value of the 'Connection' containment reference list. The list contents are of type ConnectionPointReference. It is bidirectional and its opposite is 'State'. The entry and exit connection points used in conjunction with this (submachine) State, i.e., as targets and sources, respectively, in the Region with the submachine State. A connection point reference references the corresponding definition of a connection point Pseudostate in the StateMachine referenced by the submachine State.

Returns:

the value of the 'Connection' containment reference list.

See Also:

UMLPackage.getState_Connection(), ConnectionPointReference.getState()

getRedefinedState

@CheckForNull
State getRedefinedState()

Returns the value of the 'Redefined State' reference. It is bidirectional and its opposite is 'state Of Redefined State'. The State of which this State is a redefinition.

Returns:

the value of the 'Redefined State' reference.

See Also:

setRedefinedState(State), UMLPackage.getState_RedefinedState(), get_stateOfRedefinedState()

setRedefinedState

void setRedefinedState(@CheckForNull
                       State value)

Sets the value of the 'Redefined State' reference.

Parameters:

value - the new value of the 'Redefined State' reference.

See Also:

getRedefinedState()

get_stateOfRedefinedState

java.util.Collection<State> get_stateOfRedefinedState()

Returns the value of the 'state Of Redefined State' reference list. The list contents are of type State. It is bidirectional and its opposite is 'Redefined State'.

If the meaning of the 'state Of Redefined State' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'state Of Redefined State' reference list.

See Also:

UMLPackage.getState__stateOfRedefinedState(), getRedefinedState()

getRegion

java.util.Collection<Region> getRegion()

Returns the value of the 'Region' containment reference list. The list contents are of type Region. It is bidirectional and its opposite is 'State'. The Regions owned directly by the State.

Returns:

the value of the 'Region' containment reference list.

See Also:

UMLPackage.getState_Region(), Region.getState()

getStateInvariant

@CheckForNull
Constraint getStateInvariant()

Returns the value of the 'State Invariant' reference. It is bidirectional and its opposite is 'Owning State'. Specifies conditions that are always true when this State is the current State. In ProtocolStateMachines state invariants are additional conditions to the preconditions of the outgoing Transitions, and to the postcondition of the incoming Transitions.

Returns:

the value of the 'State Invariant' reference.

See Also:

setStateInvariant(Constraint), UMLPackage.getState_StateInvariant(), Constraint.getOwningState()

setStateInvariant

void setStateInvariant(@CheckForNull
                       Constraint value)

Sets the value of the 'State Invariant' reference.

Parameters:

value - the new value of the 'State Invariant' reference.

See Also:

getStateInvariant()

getEntry

@CheckForNull
Behavior getEntry()

Returns the value of the 'Entry' containment reference. It is bidirectional and its opposite is 'state Of Entry'. An optional Behavior that is executed whenever this State is entered regardless of the Transition taken to reach the State. If defined, entry Behaviors are always executed to completion prior to any internal Behavior or Transitions performed within the State.

Returns:

the value of the 'Entry' containment reference.

See Also:

setEntry(Behavior), UMLPackage.getState_Entry(), Behavior.get_stateOfEntry()

setEntry

void setEntry(@CheckForNull
              Behavior value)

Sets the value of the 'Entry' containment reference.

Parameters:

value - the new value of the 'Entry' containment reference.

See Also:

getEntry()

getExit

@CheckForNull
Behavior getExit()

Returns the value of the 'Exit' containment reference. It is bidirectional and its opposite is 'state Of Exit'. An optional Behavior that is executed whenever this State is exited regardless of which Transition was taken out of the State. If defined, exit Behaviors are always executed to completion only after all internal and transition Behaviors have completed execution.

Returns:

the value of the 'Exit' containment reference.

See Also:

setExit(Behavior), UMLPackage.getState_Exit(), Behavior.get_stateOfExit()

setExit

void setExit(@CheckForNull
             Behavior value)

Sets the value of the 'Exit' containment reference.

Parameters:

value - the new value of the 'Exit' containment reference.

See Also:

getExit()

isComposite

boolean isComposite()

Returns the value of the 'Composite' attribute. A state with isComposite=true is said to be a composite State. A composite State is a State that contains at least one Region.

Returns:

the value of the 'Composite' attribute.

See Also:

UMLPackage.getState_Composite()

isOrthogonal

boolean isOrthogonal()

Returns the value of the 'Orthogonal' attribute. A State with isOrthogonal=true is said to be an orthogonal composite State An orthogonal composite State contains two or more Regions.

Returns:

the value of the 'Orthogonal' attribute.

See Also:

UMLPackage.getState_Orthogonal()

isSimple

boolean isSimple()

Returns the value of the 'Simple' attribute. A State with isSimple=true is said to be a simple State A simple State does not have any Regions and it does not refer to any submachine StateMachine.

Returns:

the value of the 'Simple' attribute.

See Also:

UMLPackage.getState_Simple()

isSubmachineState

boolean isSubmachineState()

Returns the value of the 'Submachine State' attribute. A State with isSubmachineState=true is said to be a submachine State Such a State refers to another StateMachine(submachine).

Returns:

the value of the 'Submachine State' attribute.

See Also:

UMLPackage.getState_SubmachineState()

getDoActivity

@CheckForNull
Behavior getDoActivity()

Returns the value of the 'Do Activity' containment reference. It is bidirectional and its opposite is 'state Of Do Activity'. An optional Behavior that is executed while being in the State. The execution starts when this State is entered, and ceases either by itself when done, or when the State is exited, whichever comes first.

Returns:

the value of the 'Do Activity' containment reference.

See Also:

setDoActivity(Behavior), UMLPackage.getState_DoActivity(), Behavior.get_stateOfDoActivity()

setDoActivity

void setDoActivity(@CheckForNull
                   Behavior value)

Sets the value of the 'Do Activity' containment reference.

Parameters:

value - the new value of the 'Do Activity' containment reference.

See Also:

getDoActivity()

getDeferrableTrigger

java.util.Collection<Trigger> getDeferrableTrigger()

Returns the value of the 'Deferrable Trigger' containment reference list. The list contents are of type Trigger. It is bidirectional and its opposite is 'state Of Deferrable Trigger'. A list of Triggers that are candidates to be retained by the StateMachine if they trigger no Transitions out of the State (not consumed). A deferred Trigger is retained until the StateMachine reaches a State configuration where it is no longer deferred.

Returns:

the value of the 'Deferrable Trigger' containment reference list.

See Also:

UMLPackage.getState_DeferrableTrigger(), Trigger.get_stateOfDeferrableTrigger()

get_objectNodeOfInState

java.util.Collection<ObjectNode> get_objectNodeOfInState()

Returns the value of the 'object Node Of In State' reference list. The list contents are of type ObjectNode. It is bidirectional and its opposite is 'In State'.

If the meaning of the 'object Node Of In State' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'object Node Of In State' reference list.

See Also:

UMLPackage.getState__objectNodeOfInState(), ObjectNode.getInState()

getConnectionPoint

java.util.Collection<Pseudostate> getConnectionPoint()

Returns the value of the 'Connection Point' containment reference list. The list contents are of type Pseudostate. It is bidirectional and its opposite is 'State'. The entry and exit Pseudostates of a composite State. These can only be entry or exit Pseudostates, and they must have different names. They can only be defined for composite States.

Returns:

the value of the 'Connection Point' containment reference list.

See Also:

UMLPackage.getState_ConnectionPoint(), Pseudostate.getState()

getRedefinitionContext

java.util.Collection<Classifier> getRedefinitionContext()

Returns the value of the 'Redefinition Context' reference list. The list contents are of type Classifier. It is bidirectional and its opposite is 'state Of Redefinition Context'. References the Classifier in which context this element may be redefined.

Specified by:

getRedefinitionContext in interface RedefinableElement

Returns:

the value of the 'Redefinition Context' reference list.

See Also:

UMLPackage.getState_RedefinitionContext(), com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Classifier#get_stateOfRedefinitionContext

hasConnection

boolean hasConnection()
               throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

hasRegion

boolean hasRegion()
           throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

hasDeferrableTrigger

boolean hasDeferrableTrigger()
                      throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

has_stateOfRedefinedState

boolean has_stateOfRedefinedState()
                           throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

has_objectNodeOfInState

boolean has_objectNodeOfInState()
                         throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

hasConnectionPoint

boolean hasConnectionPoint()
                    throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException