org.opencrx.kernel.model1.cci2
Interface Element

All Superinterfaces:

AlertSender, Auditee, BasicObject, Cloneable, ContextCapable, Creatable, CrxObject, Exporter, ExtentCapable, Importer, Indexed, Modifiable, SecureObject

All Known Subinterfaces:

AliasType, AliasType, Association, Association, AssociationEnd, AssociationEnd, Attribute, Attribute, BehaviouralFeature, BehaviouralFeature, Class, Class, Classifier, Classifier, CollectionType, CollectionType, Constant, Constant, Constraint, Constraint, Datatype, Datatype, Element, EnumerationType, EnumerationType, Exception, Exception, Feature, Feature, GeneralizableElement, GeneralizableElement, Import, Import, Namespace, Namespace, Operation, Operation, Package, Package, Parameter, Parameter, PrimitiveType, PrimitiveType, Reference, Reference, StructuralFeature, StructuralFeature, StructureField, StructureField, StructureType, StructureType, Tag, Tag, TypedElement, TypedElement

All Known Implementing Classes:

AliasType, Association, AssociationEnd, Attribute, Class, CollectionType, Constant, Constraint, Element, EnumerationType, Exception, Import, Operation, Package, Parameter, PrimitiveType, Reference, StructureField, StructureType, Tag

public interface Element
extends CrxObject

Abstract class Element

Element classifies the elementary, atomic constructs of models. Element is the root Class within the MOF Model.

Nested Class Summary

static interface

Element.Identity Object Identity

Method Summary

String	getAnnotation() Retrieves the possibly null value for the optional attribute annotation.
Namespace	getContainer() Retrieves the value for the reference container.
Integer	getElementOrder() Retrieves the possibly null value for the optional attribute elementOrder.
String	getName() Retrieves the value for the attribute name.
String	getQualifiedName() Retrieves the value for the attribute qualifiedName.
Segment	getSegment() Retrieves the value for the reference segment.
Set<String>	getStereotype() Retrieves a set containing all the elements for the attribute stereotype.
void	setAnnotation(String annotation) Sets a new value for the attribute annotation.
void	setContainer(Namespace container) Sets a new value for the reference container.
void	setElementOrder(Integer elementOrder) Sets a new value for the attribute elementOrder.
void	setName(String name) Sets a new value for the attribute name.
void	setQualifiedName(String qualifiedName) Sets a new value for the attribute qualifiedName.
void	setStereotype(String... stereotype) Clears stereotype and adds the given value(s).

Methods inherited from interface org.opencrx.kernel.generic.cci2.CrxObject

getAdditionalExternalLink, getAttachedDocument, getCategory, getDisabledReason, getDocumentFolderAssignment, getExternalLink, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, setCategory, setDisabled, setDisabledReason, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4

Methods inherited from interface org.opencrx.kernel.base.cci2.AlertSender

sendAlert

Methods inherited from interface org.opencrx.kernel.base.cci2.Auditee

getAudit

Methods inherited from interface org.opencrx.kernel.base.cci2.Cloneable

clone_

Methods inherited from interface org.opencrx.kernel.base.cci2.Exporter

exportItem, exportItemAdvanced

Methods inherited from interface org.opencrx.kernel.base.cci2.Importer

importItem

Methods inherited from interface org.opencrx.kernel.base.cci2.Indexed

getIndexEntry, updateIndex

Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject

addOwningGroup, checkPermissions, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser, setOwningUser

Methods inherited from interface org.openmdx.base.cci2.Creatable

getCreatedAt, getCreatedBy

Methods inherited from interface org.openmdx.base.cci2.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.base.cci2.Modifiable

getModifiedAt, getModifiedBy

Method Detail

getAnnotation

String getAnnotation()

Retrieves the possibly null value for the optional attribute annotation.

Provides an informal description of the Element.

Returns:

The possibly null value for attribute annotation.

setAnnotation

void setAnnotation(String annotation)

Sets a new value for the attribute annotation.

Provides an informal description of the Element.

Parameters:

annotation - The possibly null new value for attribute annotation.

getContainer

Namespace getContainer()

Retrieves the value for the reference container.

Returns:

The – possibly null – value for this reference.

setContainer

void setContainer(Namespace container)

Sets a new value for the reference container.

Parameters:

container - The non-null new value for this reference.

getElementOrder

Integer getElementOrder()

Retrieves the possibly null value for the optional attribute elementOrder.

Returns:

The possibly null value for attribute elementOrder.

setElementOrder

void setElementOrder(Integer elementOrder)

Sets a new value for the attribute elementOrder.

Parameters:

elementOrder - The possibly null new value for attribute elementOrder.

getName

String getName()

Retrieves the value for the attribute name.

Provides a meta-modeler supplied name that uniquely identifies the Element in the context of the ModelElement?s containing Namespace. When choosing an Element?s name, the meta-modeler should consider the rules for translating names into identifiers in the relevant mappings.

Returns:

The non-null value for attribute name.

setName

void setName(String name)

Sets a new value for the attribute name.

Provides a meta-modeler supplied name that uniquely identifies the Element in the context of the ModelElement?s containing Namespace. When choosing an Element?s name, the meta-modeler should consider the rules for translating names into identifiers in the relevant mappings.

Parameters:

name - The non-null new value for attribute name.

getQualifiedName

String getQualifiedName()

Retrieves the value for the attribute qualifiedName.

Provides a unique name for the Element within the context of its outermost containing Package. The qualifiedName is a list of NameType values consisting of the names of the Element, its container, its container?s container and so on until a non-contained element is reached. The first member of the list is the name of the non-contained element. The 'qualifiedName' of an Element is of the form :. is the full-qualified package name, i.e. org:omg:model1. Samples for 'qualifiedName':

• org:omg:model1:Attribute
• org:openmdx::audit2:UnitOfWork

Returns:

The non-null value for attribute qualifiedName.

setQualifiedName

void setQualifiedName(String qualifiedName)

Sets a new value for the attribute qualifiedName.

Provides a unique name for the Element within the context of its outermost containing Package. The qualifiedName is a list of NameType values consisting of the names of the Element, its container, its container?s container and so on until a non-contained element is reached. The first member of the list is the name of the non-contained element. The 'qualifiedName' of an Element is of the form :. is the full-qualified package name, i.e. org:omg:model1. Samples for 'qualifiedName':

• org:omg:model1:Attribute
• org:openmdx::audit2:UnitOfWork

Parameters:

qualifiedName - The non-null new value for attribute qualifiedName.

getSegment

Segment getSegment()

Retrieves the value for the reference segment.

Returns:

The non-null value for this reference.

getStereotype

Set<String> getStereotype()

Retrieves a set containing all the elements for the attribute stereotype.

Returns:

A set containing all elements for this attribute.

setStereotype

void setStereotype(String... stereotype)

Clears stereotype and adds the given value(s).

This method is equivalent to

   set.clear();
   set.addAll(Arrays.asList(stereotype));
 

Parameters:

stereotype - value(s) to be added to stereotype