PackageableElement interface

A PackageableElement is a NamedElement that may be owned directly by a Package.

Inheritance Hierarchy

PackageableElement NamedElement 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.
idstring Gets the unique ID of the element. Inherited from Element.
namestring The name of the NamedElement. Inherited from NamedElement.
ownedCommentsComment [0..*]The Comments owned by this Element. Inherited from Element.
ownerElement [0..1]Gets the element that owns this element. Inherited from Element.
packagePackage Gets the package that owns the packageable element. This property is derived. 
taggedValuesTaggedValueSpecification [0..*]Contains 0 or more tagged values for the element. Inherited from Element.
visibilityVisibilityKind [0..1]Determines whether and how the NamedElement is visible outside its owning Namespace. Inherited from NamedElement.

Operations

NameReturnsDescription
getFirstCommentBody()

PackageableElement.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.
getNamespaceName(separator)

PackageableElement.getNamespaceName

X

Constructs a name from the names of the nesting packages. The name is constructed working inwards from the package that is defined as namespace root up to but not including the PackageableElement itself.

Parameters
NameTypeDescription
separatorstring [0..1]The string to use to separate names. If not specified, a dot "." will be used.
Return value
Type: string 
A single string with all the names separated.
string Constructs a name from the names of the nesting packages. The name is constructed working inwards from the package that is defined as namespace root up to but not including the PackageableElement itself. 
getNestingPackages()

PackageableElement.getNestingPackages

X

Gets all packages that contain this Package, working inwards from the top Package to the owning package.

Return value
Type: Package [0..*]
A collection of Packages.
Package [0..*]Gets all packages that contain this Package, working inwards from the top Package to the owning package. 
getQualifiedName(separator)

PackageableElement.getQualifiedName

X

Constructs a name from the PackageableElement and the names of the nesting packages. The name is constructed working inwards from the package that is defined as namespace root up to and including the PackageableElement itself.

Parameters
NameTypeDescription
separatorstring [0..1]The string to use to separate names. If not specified, a dot "." will be used.
Return value
Type: string 
A single string with all the names separated.
string Constructs a name from the PackageableElement and the names of the nesting packages. The name is constructed working inwards from the package that is defined as namespace root up to and including the PackageableElement itself.