com.nomagic.uml2.ext.magicdraw.activities.mdstructuredactivities

Interface Clause

All Superinterfaces:

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

public interface Clause
extends Element

A representation of the model object 'Clause'.

A Clause is an Element that represents a single branch of a ConditionalNode, including a test and a body section. The body section is executed only if (but not necessarily if) the test section evaluates to true.

The following features are supported:

• Body
• Body Output
• Decider
• Predecessor Clause
• Successor Clause
• Test
• conditional Node Of Clause

See Also:

UMLPackage.getClause()

Method Summary

Modifier and Type	Method and Description
ConditionalNode	get_conditionalNodeOfClause() Returns the value of the 'conditional Node Of Clause' container reference.
java.util.Collection<ExecutableNode>	getBody() Returns the value of the 'Body' reference list.
java.util.List<OutputPin>	getBodyOutput() Returns the value of the 'Body Output' reference list.
OutputPin	getDecider() Returns the value of the 'Decider' reference.
java.util.Collection<Clause>	getPredecessorClause() Returns the value of the 'Predecessor Clause' reference list.
java.util.Collection<Clause>	getSuccessorClause() Returns the value of the 'Successor Clause' reference list.
java.util.Collection<ExecutableNode>	getTest() Returns the value of the 'Test' reference list.
boolean	hasBody()
boolean	hasBodyOutput()
boolean	hasPredecessorClause()
boolean	hasSuccessorClause()
boolean	hasTest()
void	set_conditionalNodeOfClause(ConditionalNode value) Sets the value of the 'conditional Node Of Clause' container reference.
void	setDecider(OutputPin value) Sets the value of the 'Decider' reference.

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

getTest

java.util.Collection<ExecutableNode> getTest()

Returns the value of the 'Test' reference list. The list contents are of type ExecutableNode. It is bidirectional and its opposite is 'clause Of Test'. The set of ExecutableNodes that are executed in order to provide a test result for the Clause.

Returns:

the value of the 'Test' reference list.

See Also:

UMLPackage.getClause_Test(), ExecutableNode.get_clauseOfTest()

getBody

java.util.Collection<ExecutableNode> getBody()

Returns the value of the 'Body' reference list. The list contents are of type ExecutableNode. It is bidirectional and its opposite is 'clause Of Body'. The set of ExecutableNodes that are executed if the test evaluates to true and the Clause is chosen over other Clauses within the ConditionalNode that also have tests that evaluate to true.

Returns:

the value of the 'Body' reference list.

See Also:

UMLPackage.getClause_Body(), ExecutableNode.get_clauseOfBody()

getPredecessorClause

java.util.Collection<Clause> getPredecessorClause()

Returns the value of the 'Predecessor Clause' reference list. The list contents are of type Clause. It is bidirectional and its opposite is 'Successor Clause'. A set of Clauses whose tests must all evaluate to false before this Clause can evaluate its test.

Returns:

the value of the 'Predecessor Clause' reference list.

See Also:

UMLPackage.getClause_PredecessorClause(), getSuccessorClause()

getSuccessorClause

java.util.Collection<Clause> getSuccessorClause()

Returns the value of the 'Successor Clause' reference list. The list contents are of type Clause. It is bidirectional and its opposite is 'Predecessor Clause'. A set of Clauses that may not evaluate their tests unless the test for this Clause evaluates to false.

Returns:

the value of the 'Successor Clause' reference list.

See Also:

UMLPackage.getClause_SuccessorClause(), getPredecessorClause()

getBodyOutput

java.util.List<OutputPin> getBodyOutput()

Returns the value of the 'Body Output' reference list. The list contents are of type OutputPin. It is bidirectional and its opposite is 'clause Of Body Output'. The OutputPins on Actions within the body section whose values are moved to the result OutputPins of the containing ConditionalNode after execution of the body.

Returns:

the value of the 'Body Output' reference list.

See Also:

UMLPackage.getClause_BodyOutput(), OutputPin.get_clauseOfBodyOutput()

get_conditionalNodeOfClause

@CheckForNull
ConditionalNode get_conditionalNodeOfClause()

Returns the value of the 'conditional Node Of Clause' container reference. It is bidirectional and its opposite is 'Clause'.

If the meaning of the 'conditional Node Of Clause' container reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'conditional Node Of Clause' container reference.

See Also:

set_conditionalNodeOfClause(ConditionalNode), UMLPackage.getClause__conditionalNodeOfClause(), ConditionalNode.getClause()

set_conditionalNodeOfClause

void set_conditionalNodeOfClause(@CheckForNull
                                 ConditionalNode value)

Sets the value of the 'conditional Node Of Clause' container reference.

Parameters:

value - the new value of the 'conditional Node Of Clause' container reference.

See Also:

get_conditionalNodeOfClause()

getDecider

@CheckForNull
OutputPin getDecider()

Returns the value of the 'Decider' reference. It is bidirectional and its opposite is 'clause Of Decider'. An OutputPin on an Action in the test section whose Boolean value determines the result of the test.

Returns:

the value of the 'Decider' reference.

See Also:

setDecider(OutputPin), UMLPackage.getClause_Decider(), OutputPin.get_clauseOfDecider()

setDecider

void setDecider(@CheckForNull
                OutputPin value)

Sets the value of the 'Decider' reference.

Parameters:

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

See Also:

getDecider()

hasTest

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

Throws:

javax.jmi.reflect.JmiException

hasBody

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

Throws:

javax.jmi.reflect.JmiException

hasPredecessorClause

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

Throws:

javax.jmi.reflect.JmiException

hasSuccessorClause

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

Throws:

javax.jmi.reflect.JmiException

hasBodyOutput

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

Throws:

javax.jmi.reflect.JmiException