com.nomagic.uml2.ext.magicdraw.interactions.mdfragments

Interface InteractionUse

All Superinterfaces:

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

All Known Subinterfaces:

PartDecomposition

public interface InteractionUse
extends InteractionFragment

A representation of the model object 'Interaction Use'.

An InteractionUse refers to an Interaction. The InteractionUse is a shorthand for copying the contents of the referenced Interaction where the InteractionUse is. To be accurate the copying must take into account substituting parameters with arguments and connect the formal Gates with the actual ones.

The following features are supported:

• Actual Gate
• Argument
• Refers To
• Return Value
• Return Value Recipient

See Also:

UMLPackage.getInteractionUse()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Gate>	getActualGate() Returns the value of the 'Actual Gate' containment reference list.
java.util.List<ValueSpecification>	getArgument() Returns the value of the 'Argument' containment reference list.
Interaction	getRefersTo() Returns the value of the 'Refers To' reference.
ValueSpecification	getReturnValue() Returns the value of the 'Return Value' containment reference.
Property	getReturnValueRecipient() Returns the value of the 'Return Value Recipient' reference.
boolean	hasActualGate()
boolean	hasArgument()
void	setRefersTo(Interaction value) Sets the value of the 'Refers To' reference.
void	setReturnValue(ValueSpecification value) Sets the value of the 'Return Value' containment reference.
void	setReturnValueRecipient(Property value) Sets the value of the 'Return Value Recipient' reference.

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.interactions.mdbasicinteractions.InteractionFragment

getCovered, getEnclosingInteraction, getEnclosingOperand, getGeneralOrdering, hasCovered, hasGeneralOrdering, setEnclosingInteraction, setEnclosingOperand

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

getRefersTo

@CheckForNull
Interaction getRefersTo()

Returns the value of the 'Refers To' reference. It is bidirectional and its opposite is 'interaction Use Of Refers To'. Refers to the Interaction that defines its meaning.

Returns:

the value of the 'Refers To' reference.

See Also:

setRefersTo(Interaction), UMLPackage.getInteractionUse_RefersTo(), Interaction.get_interactionUseOfRefersTo()

setRefersTo

void setRefersTo(@CheckForNull
                 Interaction value)

Sets the value of the 'Refers To' reference.

Parameters:

value - the new value of the 'Refers To' reference.

See Also:

getRefersTo()

getArgument

java.util.List<ValueSpecification> getArgument()

Returns the value of the 'Argument' containment reference list. The list contents are of type ValueSpecification. It is bidirectional and its opposite is 'interaction Use Of Argument'. The actual arguments of the Interaction.

Returns:

the value of the 'Argument' containment reference list.

See Also:

UMLPackage.getInteractionUse_Argument(), ValueSpecification.get_interactionUseOfArgument()

getReturnValue

@CheckForNull
ValueSpecification getReturnValue()

Returns the value of the 'Return Value' containment reference. It is bidirectional and its opposite is 'interaction Use Of Return Value'. The value of the executed Interaction.

Returns:

the value of the 'Return Value' containment reference.

See Also:

setReturnValue(ValueSpecification), UMLPackage.getInteractionUse_ReturnValue(), ValueSpecification.get_interactionUseOfReturnValue()

setReturnValue

void setReturnValue(@CheckForNull
                    ValueSpecification value)

Sets the value of the 'Return Value' containment reference.

Parameters:

value - the new value of the 'Return Value' containment reference.

See Also:

getReturnValue()

getReturnValueRecipient

@CheckForNull
Property getReturnValueRecipient()

Returns the value of the 'Return Value Recipient' reference. It is bidirectional and its opposite is 'interaction Use Of Return Value Recipient'. The recipient of the return value.

Returns:

the value of the 'Return Value Recipient' reference.

See Also:

setReturnValueRecipient(Property), UMLPackage.getInteractionUse_ReturnValueRecipient(), Property.get_interactionUseOfReturnValueRecipient()

setReturnValueRecipient

void setReturnValueRecipient(@CheckForNull
                             Property value)

Sets the value of the 'Return Value Recipient' reference.

Parameters:

value - the new value of the 'Return Value Recipient' reference.

See Also:

getReturnValueRecipient()

getActualGate

java.util.Collection<Gate> getActualGate()

Returns the value of the 'Actual Gate' containment reference list. The list contents are of type Gate. It is bidirectional and its opposite is 'interaction Use Of Actual Gate'. The actual gates of the InteractionUse.

Returns:

the value of the 'Actual Gate' containment reference list.

See Also:

UMLPackage.getInteractionUse_ActualGate(), Gate.get_interactionUseOfActualGate()

hasArgument

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

Throws:

javax.jmi.reflect.JmiException

hasActualGate

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

Throws:

javax.jmi.reflect.JmiException