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

Interface State

    • Method Detail

      • 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()
        Generated:

      • 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()
        Model:
        opposite="state" containment="true" resolveProxies="true" ordered="false"
        Generated:

      • 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()
        Model:
        opposite="state" containment="true" resolveProxies="true" ordered="false"
        Generated:

      • 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()
        Model:
        opposite="owningState" ordered="false"
        Generated:

      • 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()
        Generated:

      • 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()
        Model:
        opposite="_stateOfEntry" containment="true" resolveProxies="true" ordered="false"
        Generated:

      • 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()
        Generated:

      • 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()
        Model:
        opposite="_stateOfExit" containment="true" resolveProxies="true" ordered="false"
        Generated:

      • 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()
        Generated:

      • 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:
        com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage#getState_Composite()
        Model:
        dataType="com.nomagic.uml2.ext.magicdraw.Boolean" required="true" transient="true" changeable="false" volatile="true" derived="true" ordered="false"
        Generated:

      • 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:
        com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage#getState_Orthogonal()
        Model:
        dataType="com.nomagic.uml2.ext.magicdraw.Boolean" required="true" transient="true" changeable="false" volatile="true" derived="true" ordered="false"
        Generated:

      • 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:
        com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage#getState_Simple()
        Model:
        dataType="com.nomagic.uml2.ext.magicdraw.Boolean" required="true" transient="true" changeable="false" volatile="true" derived="true" ordered="false"
        Generated:

      • 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:
        com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage#getState_SubmachineState()
        Model:
        dataType="com.nomagic.uml2.ext.magicdraw.Boolean" required="true" transient="true" changeable="false" volatile="true" derived="true" ordered="false"
        Generated:

      • 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()
        Model:
        opposite="_stateOfDoActivity" containment="true" resolveProxies="true" ordered="false"
        Generated:

      • 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()
        Generated:

      • 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()
        Model:
        opposite="_stateOfDeferrableTrigger" containment="true" resolveProxies="true" ordered="false"
        Generated:

      • 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()
        Model:
        opposite="inState" ordered="false"
        Generated:

      • 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()
        Model:
        opposite="state" containment="true" resolveProxies="true" ordered="false"
        Generated:

      • hasConnection

        boolean hasConnection()
               throws javax.jmi.reflect.JmiException
        Throws:
        javax.jmi.reflect.JmiException
        Generated:

      • hasRegion

        boolean hasRegion()
           throws javax.jmi.reflect.JmiException
        Throws:
        javax.jmi.reflect.JmiException
        Generated:

      • hasDeferrableTrigger

        boolean hasDeferrableTrigger()
                      throws javax.jmi.reflect.JmiException
        Throws:
        javax.jmi.reflect.JmiException
        Generated:

      • has_objectNodeOfInState

        boolean has_objectNodeOfInState()
                         throws javax.jmi.reflect.JmiException
        Throws:
        javax.jmi.reflect.JmiException
        Generated:

      • hasConnectionPoint

        boolean hasConnectionPoint()
                    throws javax.jmi.reflect.JmiException
        Throws:
        javax.jmi.reflect.JmiException
        Generated: