Parameter interface

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.

Inheritance Hierarchy

Parameter TypedElement NamedElement Element
Parameter MultiplicityElement Element
Parameter OrderedElement Element

Attributes

NameTypeDescription
appliedStereotypesStereotype [0..*]Indicates which stereotypes from the selected profile (or profiles) are applied to the element. The selected profiles are the profiles that are applied to the containing package. Inherited from Element.
defaultValueValueSpecification [0..1]Specifies a ValueSpecification that represents a value to be used when no argument is supplied for the Parameter. 
directionParameterDirectionKind [1..1] 
idstring Gets the unique ID of the element. Inherited from Element.
isExceptionboolean Tells whether an output parameter may emit a value to the exclusion of the other outputs. 
isOrderedboolean For a multivalued multiplicity, this attribute specifies whether the values in an instantiation of this MultiplicityElement are sequentially ordered. Inherited from MultiplicityElement.
isStreamboolean 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. 
isUniqueboolean For a multivalued multiplicity, this attributes specifies whether the values in an instantiation of this MultiplicityElement are unique. Inherited from MultiplicityElement.
lowerinteger [0..1]Gets the lower bound of the multiplicity interval. Inherited from MultiplicityElement.
lowerValueValueSpecification [0..1]The specification of the lower bound for this multiplicity. Inherited from MultiplicityElement.
namestring The name of the NamedElement. Inherited from NamedElement.
orderinteger [1..1]Gets or set the sort order of the element if it is part of a collection. The value is 0 for elements to which no particular ordering applies. Elements with a lower order come before elements with a higher order. Inherited from OrderedElement.
ownedCommentsComment [0..*]The Comments owned by this Element. Inherited from Element.
ownerElement [0..1]Gets the element that owns this element. Inherited from Element.
taggedValuesTaggedValueSpecification [0..*]Contains 0 or more tagged values for the element. Inherited from Element.
typeType [0..1]The type of the TypedElement. Inherited from TypedElement.
upperUnlimitedNatural [0..1]The upper bound of the multiplicity interval. Inherited from MultiplicityElement.
upperValueValueSpecification [0..1]The specification of the upper bound for this multiplicity. Inherited from MultiplicityElement.
visibilityVisibilityKind [0..1]Determines whether and how the NamedElement is visible outside its owning Namespace. Inherited from NamedElement.

Operations

NameReturnsDescription
getDefault()

Parameter.getDefault

X

Gets the value of the DefaultValue property.

Return value
Type: object [0..1]
The default value (the type depending on the type of value), or null if no default value can be determined.
object [0..1]Gets the value of the DefaultValue property. 
getFirstCommentBody()

Parameter.getFirstCommentBody

X

Gets the text contents of the first comment in the element's owned comments, or an empty string if the element has no comments.

Return value
Type: string [1..1]
The body string of the first comment. If the element has no comments, an empty string is returned.
string [1..1]Gets the text contents of the first comment in the element's owned comments, or an empty string if the element has no comments. Inherited from Element.
getLowerBound()

Parameter.getLowerBound

X

The query lowerBound() returns the lower bound of the multiplicity as an integer, which is the integerValue of lowerValue, if this is given, and 1 otherwise.

Return value
Type: integer 
integer The query lowerBound() returns the lower bound of the multiplicity as an integer, which is the integerValue of lowerValue, if this is given, and 1 otherwise. Inherited from MultiplicityElement.
getTypeName()

Parameter.getTypeName

X

Gets the name of the typed element's type.

Return value
Type: string [1..1]
The type name, or an empty string if the element has no type.
string [1..1]Gets the name of the typed element's type. Inherited from TypedElement.
getUpperBound()

Parameter.getUpperBound

X

The query upperBound() returns the upper bound of the multiplicity for a bounded multiplicity as an unlimited natural, which is the unlimitedNaturalValue of upperValue, if given, and 1, otherwise.

Return value
Type: UnlimitedNatural 
UnlimitedNatural The query upperBound() returns the upper bound of the multiplicity for a bounded multiplicity as an unlimited natural, which is the unlimitedNaturalValue of upperValue, if given, and 1, otherwise. Inherited from MultiplicityElement.
isMultivalued()

Parameter.isMultivalued

X

The query isMultivalued() checks whether this multiplicity has an upper bound greater than one.

Return value
Type: boolean 
boolean The query isMultivalued() checks whether this multiplicity has an upper bound greater than one. Inherited from MultiplicityElement.
isOptional()

Parameter.isOptional

X

The query isOptional checks whether this multiplicity has a lower bound of 0 (0..n).

Return value
Type: boolean 
boolean The query isOptional checks whether this multiplicity has a lower bound of 0 (0..n). Inherited from MultiplicityElement.
isOptionalAndSinglevalued()

Parameter.isOptionalAndSinglevalued

X

The query isOptionalAndSingleValued checks whether this multiplicity has a lower bound of 0 and an upper bound of 1 (0..1).

Return value
Type: boolean 
boolean The query isOptionalAndSingleValued checks whether this multiplicity has a lower bound of 0 and an upper bound of 1 (0..1). Inherited from MultiplicityElement.
isRequiredAndSinglevalued()

Parameter.isRequiredAndSinglevalued

X

The query isRequiredAndSinglevalued checks whether this multiplicity has a lower bound of 1 and an upper bound of 1 (1..1).

Return value
Type: boolean 
boolean The query isRequiredAndSinglevalued checks whether this multiplicity has a lower bound of 1 and an upper bound of 1 (1..1). Inherited from MultiplicityElement.