Package com.nomagic.uml2.ext.magicdraw.classes.mdkernel

Interface Parameter

All Superinterfaces:

BaseElement, Cloneable, Comparable, ConnectableElement, Element, org.eclipse.emf.ecore.EObject, MDObject, com.dassault_systemes.modeler.foundation.model.ModelElement, ModelObject, MultiplicityElement, NamedElement, org.eclipse.emf.common.notify.Notifier, ParameterableElement, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, TypedElement

public interface Parameter
extends ConnectableElement, MultiplicityElement

A representation of the model object 'Parameter'.

A Parameter is a specification of an argument used to pass information into or out of an invocation of a BehavioralFeature. Parameters can be treated as ConnectableElements within Collaborations.

The following features are supported:

• Owner Formal Param
• Parameter Set
• Operation
• Default Value
• Default
• Direction
• Effect
• Exception
• Stream
• activity Parameter Node Of Parameter
• behavior Of Owned Parameter

See Also:

• UMLPackage.getParameter()

Model:

annotation="MOF package='classes.mdkernel'"

Generated:

Method Summary

Modifier and Type	Method	Description
Collection<ActivityParameterNode>	get_activityParameterNodeOfParameter()	Returns the value of the 'activity Parameter Node Of Parameter' reference list.
Behavior	get_behaviorOfOwnedParameter()	Returns the value of the 'behavior Of Owned Parameter' container reference.
String	getDefault()	Returns the value of the 'Default' attribute.
ValueSpecification	getDefaultValue()	Returns the value of the 'Default Value' containment reference.
ParameterDirectionKind	getDirection()	Returns the value of the 'Direction' attribute.
ParameterEffectKind	getEffect()	Returns the value of the 'Effect' attribute.
Operation	getOperation()	Returns the value of the 'Operation' container reference.
BehavioralFeature	getOwnerFormalParam()	Returns the value of the 'Owner Formal Param' container reference.
Collection<ParameterSet>	getParameterSet()	Returns the value of the 'Parameter Set' reference list.
boolean	has_activityParameterNodeOfParameter()
boolean	hasParameterSet()
boolean	isException()	Returns the value of the 'Exception' attribute.
boolean	isStream()	Returns the value of the 'Stream' attribute.
void	set_behaviorOfOwnedParameter(Behavior value)	Sets the value of the 'behavior Of Owned Parameter' container reference.
void	setDefaultValue(ValueSpecification value)	Sets the value of the 'Default Value' containment reference.
void	setDirection(ParameterDirectionKind value)	Sets the value of the 'Direction' attribute.
void	setEffect(ParameterEffectKind value)	Sets the value of the 'Effect' attribute.
void	setException(boolean value)	Sets the value of the 'Exception' attribute.
void	setOperation(Operation value)	Sets the value of the 'Operation' container reference.
void	setOwnerFormalParam(BehavioralFeature value)	Sets the value of the 'Owner Formal Param' container reference.
void	setStream(boolean value)	Sets the value of the 'Stream' attribute.

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

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.compositestructures.mdinternalstructures.ConnectableElement

get_collaborationOfCollaborationRole, get_lifelineOfRepresents, get_structuredClassifierOfRole, getEnd, getTemplateParameter, has_collaborationOfCollaborationRole, has_lifelineOfRepresents, has_structuredClassifierOfRole, hasEnd, setTemplateParameter

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_elementTaggedValue, get_elementValueOfElement, get_relationshipOfRelatedElement, getAppliedStereotype, getOwnedComment, getOwnedElement, getOwner, getSyncElement, getTaggedValue, has_activityPartitionOfRepresents, has_commentOfAnnotatedElement, has_constraintOfConstrainedElement, has_diagramOfContext, has_directedRelationshipOfSource, has_directedRelationshipOfTarget, has_elementOfSyncElement, has_elementValueOfElement, has_relationshipOfRelatedElement, hasAppliedStereotype, hasElementTaggedValue, hasOwnedComment, hasOwnedElement, hasTaggedValue, setOwner, setSyncElement

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 com.nomagic.magicdraw.foundation.MDObject

getID, getMDExtension, getMdExtensions, setID

Methods inherited from interface com.dassault_systemes.modeler.foundation.model.ModelElement

canChangeElementOwner, eDynamicGet, getElementOwner, getLocalID, getObjectParent, selfDispose, setLocalID, sGetLocalID

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

get_representationText, ignoringRefGetValue, ignoringRefGetValue, isSet, refGetValue, refGetValue, refSetValue, refSetValue, set_representationText

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

getLower, getLowerValue, getUpper, getUpperValue, isOrdered, isUnique, setLowerValue, setOrdered, setUnique, setUpperValue

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 org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.auxiliaryconstructs.mdtemplates.ParameterableElement

get_templateParameterOfDefault, get_templateParameterOfOwnedDefault, get_templateParameterSubstitutionOfActual, get_templateParameterSubstitutionOfOwnedActual, getOwningTemplateParameter, has_templateParameterOfDefault, has_templateParameterSubstitutionOfActual, set_templateParameterOfOwnedDefault, set_templateParameterSubstitutionOfOwnedActual, setOwningTemplateParameter, setTemplateParameter

Methods inherited from interface javax.jmi.reflect.RefBaseObject

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

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refInvokeOperation, refInvokeOperation, refSetValue

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

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

getType, setType

Method Details

getParameterSet

Collection<ParameterSet> getParameterSet()

Returns the value of the 'Parameter Set' reference list. The list contents are of type ParameterSet. It is bidirectional and its opposite is 'Parameter'. The ParameterSets containing the parameter. See ParameterSet.

Returns:

the value of the 'Parameter Set' reference list.

See Also:

• UMLPackage.getParameter_ParameterSet()
• ParameterSet.getParameter()

Model:

opposite="parameter" ordered="false"

Generated:

get_behaviorOfOwnedParameter

@CheckForNull
Behavior get_behaviorOfOwnedParameter()

Returns the value of the 'behavior Of Owned Parameter' container reference. It is bidirectional and its opposite is 'Owned Parameter'.

If the meaning of the 'behavior Of Owned Parameter' container reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'behavior Of Owned Parameter' container reference.

See Also:

• set_behaviorOfOwnedParameter(Behavior)
• UMLPackage.getParameter__behaviorOfOwnedParameter()
• Behavior.getOwnedParameter()

Model:

opposite="ownedParameter" transient="false" ordered="false"

Generated:

set_behaviorOfOwnedParameter

void set_behaviorOfOwnedParameter(@CheckForNull
 Behavior value)

Sets the value of the 'behavior Of Owned Parameter' container reference.

Parameters:

value - the new value of the 'behavior Of Owned Parameter' container reference.

See Also:

• get_behaviorOfOwnedParameter()

Generated:

get_activityParameterNodeOfParameter

Collection<ActivityParameterNode> get_activityParameterNodeOfParameter()

Returns the value of the 'activity Parameter Node Of Parameter' reference list. The list contents are of type ActivityParameterNode. It is bidirectional and its opposite is 'Parameter'.

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

Returns:

the value of the 'activity Parameter Node Of Parameter' reference list.

See Also:

• UMLPackage.getParameter__activityParameterNodeOfParameter()
• ActivityParameterNode.getParameter()

Model:

opposite="parameter" ordered="false"

Generated:

getDirection

@CheckForNull
ParameterDirectionKind getDirection()

Returns the value of the 'Direction' attribute. The default value is "in". The literals are from the enumeration ParameterDirectionKind. Indicates whether a parameter is being sent into or out of a behavioral element.

Returns:

the value of the 'Direction' attribute.

See Also:

• ParameterDirectionKind
• setDirection(ParameterDirectionKind)
• UMLPackage.getParameter_Direction()

Model:

default="in" required="true" ordered="false"

Generated:

setDirection

void setDirection(@CheckForNull
 ParameterDirectionKind value)

Sets the value of the 'Direction' attribute.

Parameters:

value - the new value of the 'Direction' attribute.

See Also:

• ParameterDirectionKind
• getDirection()

Generated:

getDefault

@CheckForNull
String getDefault()

Returns the value of the 'Default' attribute. The default value is "". A String that represents a value to be used when no argument is supplied for the Parameter.

Returns:

the value of the 'Default' attribute.

See Also:

• UMLPackage.getParameter_Default()

Model:

default="" dataType="com.nomagic.uml2.ext.magicdraw.String" transient="true" changeable="false" volatile="true" derived="true" ordered="false"

Generated:

getDefaultValue

@CheckForNull
ValueSpecification getDefaultValue()

Returns the value of the 'Default Value' containment reference. It is bidirectional and its opposite is 'Owning Parameter'. Specifies a ValueSpecification that represents a value to be used when no argument is supplied for the Parameter.

Returns:

the value of the 'Default Value' containment reference.

See Also:

• setDefaultValue(ValueSpecification)
• UMLPackage.getParameter_DefaultValue()
• ValueSpecification.getOwningParameter()

Model:

opposite="owningParameter" containment="true" resolveProxies="true" ordered="false"

Generated:

setDefaultValue

void setDefaultValue(@CheckForNull
 ValueSpecification value)

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

Parameters:

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

See Also:

• getDefaultValue()

Generated:

getOperation

@CheckForNull
Operation getOperation()

Returns the value of the 'Operation' container reference. It is bidirectional and its opposite is 'Owned Parameter'. The Operation owning this parameter.

Returns:

the value of the 'Operation' container reference.

See Also:

• setOperation(Operation)
• UMLPackage.getParameter_Operation()
• Operation.getOwnedParameter()

Model:

opposite="ownedParameter" volatile="true" ordered="false"

Generated:

setOperation

void setOperation(@CheckForNull
 Operation value)

Sets the value of the 'Operation' container reference.

Parameters:

value - the new value of the 'Operation' container reference.

See Also:

• getOperation()

Generated:

getEffect

@CheckForNull
ParameterEffectKind getEffect()

Returns the value of the 'Effect' attribute. Specifies the effect that executions of the owner of the Parameter have on objects passed in or out of the parameter.

Returns:

the value of the 'Effect' attribute.

See Also:

• setEffect(ParameterEffectKind)
• UMLPackage.getParameter_Effect()

Model:

dataType="com.nomagic.uml2.ext.magicdraw.ParameterParameterEffectKind" ordered="false"

Generated:

setEffect

void setEffect(@CheckForNull
 ParameterEffectKind value)

Sets the value of the 'Effect' attribute.

Parameters:

value - the new value of the 'Effect' attribute.

See Also:

• getEffect()

Generated:

isException

boolean isException()

Returns the value of the 'Exception' attribute. The default value is "false". Tells whether an output parameter may emit a value to the exclusion of the other outputs.

Returns:

the value of the 'Exception' attribute.

See Also:

• setException(boolean)
• com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage#getParameter_Exception()

Model:

default="false" dataType="com.nomagic.uml2.ext.magicdraw.Boolean" required="true" ordered="false"

Generated:

setException

void setException(boolean value)

Sets the value of the 'Exception' attribute.

Parameters:

value - the new value of the 'Exception' attribute.

See Also:

• isException()

Generated:

isStream

boolean isStream()

Returns the value of the 'Stream' attribute. The default value is "false". Tells whether an input parameter may accept values while its behavior is executing, or whether an output parameter may post values while the behavior is executing.

Returns:

the value of the 'Stream' attribute.

See Also:

• setStream(boolean)
• com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage#getParameter_Stream()

Model:

default="false" dataType="com.nomagic.uml2.ext.magicdraw.Boolean" required="true" ordered="false"

Generated:

setStream

void setStream(boolean value)

Sets the value of the 'Stream' attribute.

Parameters:

value - the new value of the 'Stream' attribute.

See Also:

• isStream()

Generated:

getOwnerFormalParam

@CheckForNull
BehavioralFeature getOwnerFormalParam()

Returns the value of the 'Owner Formal Param' container reference. It is bidirectional and its opposite is 'Owned Parameter'.

If the meaning of the 'Owner Formal Param' container reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Owner Formal Param' container reference.

See Also:

• setOwnerFormalParam(BehavioralFeature)
• UMLPackage.getParameter_OwnerFormalParam()
• BehavioralFeature.getOwnedParameter()

Model:

opposite="ownedParameter" transient="false" ordered="false"

Generated:

setOwnerFormalParam

void setOwnerFormalParam(@CheckForNull
 BehavioralFeature value)

Sets the value of the 'Owner Formal Param' container reference.

Parameters:

value - the new value of the 'Owner Formal Param' container reference.

See Also:

• getOwnerFormalParam()

Generated:

hasParameterSet

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

Throws:

javax.jmi.reflect.JmiException

Generated:

has_activityParameterNodeOfParameter

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

Throws:

javax.jmi.reflect.JmiException

Generated: