rs.sol.soloist.server.uml.concepts.runtime
Interface IClassifierInstance

All Superinterfaces:

rs.sol.soloist.server.uml.concepts.IElement, IRTElement

All Known Subinterfaces:

IClassInstance, IDataTypeInstance, IEnumerationInstance, ILinkObject, IPrimitiveTypeInstance

All Known Implementing Classes:

rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance, rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance, rs.sol.soloist.server.uml.commonimplementation.runtime._DataTypeInstance, Boolean, CellLayout, CellLayoutData, Color, rs.sol.soloist.server.builtindomains.commands.Command, Currency, Date, DateTime, DockLayout, DockLayoutData, DockLayoutDirection, File, FilteringLogic, FlowLayout, Font, GUIAndGate, GUIApplicationComponent, GUIBindingsFeature, GUIBooleanFilter, GUIBufferComponent, GUIButtonComponent, GUIClassifierSetting, GUIClassInstancesSAPComponent, GUICollectionFilter, GUICollectionInput, GUIComboWidget, GUICommandComponent, GUICommandsFeature, GUIComparationFilter, GUIComponent, GUIComponentBinding, GUIConformsToFilter, GUIContainerComponent, GUIContext, GUIDataTypeInstanceSetting, GUIDateTimeFormat, GUIDateTimeTextFeature, GUIDeckComponent, GUIDefaultNavigatorFeature, GUIDefaultTextFeature, GUIDialogComponent, GUIDisclosurePanel, GUIDynamicallyVisibleTabsComponent, GUIDynamicContentsPanel, GUIEdit, GUIElementComponent, GUIElementComponentKind, GUIElementInput, GUIElementSetting, GUIEnumerationLiteralSetting, GUIFieldWidget, GUIFilterComponent, GUIFindAllInstancesSAPComponent, GUIFindSingleInstanceSAPComponent, GUIGetElementAt, GUIHasElementInputWidget, GUIHTMLComponent, GUIImageComponent, GUIIndexOfElement, GUIInput, GUIInputKind, GUIItemSetting, GUILabelComponent, GUILazyPanel, GUILinkComponent, GUIListWidget, GUILogicGateComponent, GUIMenuComponent, GUIMenuItemComponent, GUIMultiFileUplaod, GUIMultipleElementWidget, GUIMultiplicityFilter, GUIMultitypingFeature, GUINavigatorFeature, GUINonVisualComponent, GUINotGate, GUINullFilter, GUINullSetting, GUINumberFormat, GUINumberTextFeature, GUIObjectSetting, GUIOrGate, GUIPanelComponent, GUIParametrizedInput, GUIPictureFeature, GUIPropertySetting, GUIRelayComponent, GUIScrollPanel, GUISearchPanelComponent, GUISearchResultComponent, GUIServiceAccessPointComponent, GUISettingFeature, GUISingleElementComponent, GUISlotEditorKind, GUISlotListenerComponent, GUISlotSetting, GUISlotValueInput, GUIStatusBarComponent, GUISubnodesInput, GUISuggestWidget, GUITabComponent, GUITableWidget, GUITextFeature, GUITimerComponent, GUITransformerComponent, GUITreeWidget, GUIWidget, HorizontalAlignment, HorizontalLayout, InstanceOfDataType, InstanceOfEnumeration, InstanceOfPrimitiveType, Integer, LayerLayout, LayerLayoutData, Layout, LayoutData, rs.sol.soloist.server.builtindomains.common.ObjectOfClass, PerformImmediately, Picture, PropertyKind, Real, rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance, rs.sol.soloist.server.javaimpl.runtime.SOLoistDataTypeInstance, TableColumnData, TableCommand, TableLayout, TableLayoutData, TableRowData, Text, Time, TimeInterval, ToSlotTransformer, ToSlotValueByPropertyTransformer, ToSlotValueTransformer, Transformer, VerticalAlignment, VerticalLayout, XYLayout, XYLayoutData

public interface IClassifierInstance
extends IRTElement

Abstract generalization of instances of Classifiers that live at runtime in the object space.

Method Summary

boolean	conformsTo(IClassifierInstance ci) Does this Classifier Instance conform to the given one? Relies on the same operation of the instances' Classifiers.
void	constructor() The domain-specific constructor of the Classifier.
void	copySlots(IClassifierInstance ciFrom) Copies the values of all Slots of the given Classifier Instance ciFrom to the corresponding Slots (of the same Properties) of this Classifier Instance.
void	copySlots(IClassifierInstance ciFrom, boolean toCopyAssociationEnds) Copies the values of all Slots of the given Classifier Instance ciFrom to the corresponding Slots (of the same Properties) of this Classifier Instance.
void	destroy() Destroys this Classifier Instance.
void	destructor() The domain-specific destructor of the Classifier.
IAttributeValue	getAttributeValue(IProperty prop) Returns the Attribute Value owned by this Classifier Instance that is an instance of the given Property.
IAttributeValue	getAttributeValue(java.lang.String uqName, IClassifier cls) Returns the Attribute Value owned by this Classifier Instance with the given unqualified name.
IAttributeValue	getAttributeValue(java.lang.String uqName, java.lang.String clsFQName) Returns the Attribute Value owned by this Classifier Instance with the given unqualified name.
java.util.List<IAttributeValue>	getAttributeValues() Returns the set of all Attribute Values owned by this Classifier Instance.
IClassifier	getClassifier() Returns the Classifier of the UML model whose instance is this.
java.lang.String	getClassifierFQName() Returns the fully qualified name of the instance's Classifier.
java.lang.String	getClassifierUQName() Returns the unqualified name of the instance's Classifier.
IClassifier	getFirstCommonGeneralizer(IClassifierInstance ci) Returns the closest generalized Classifier of this and the given Classifier Instance.
java.lang.String	getFirstCommonGeneralizerFQName(IClassifierInstance ci) Returns the fully qualified name of the Classifier that is the closest generalized Classifier of this and the given Classifier Instance.
java.lang.String	getFirstCommonGeneralizerUQName(IClassifierInstance ci) Returns the unqualified name of the Classifier that is the closest generalized Classifier of this and the given Classifier Instance.
long	getMyID() Returns unique identifier of this classifier instance.
ISlot	getSlot(IProperty prop) Returns the Slot owned by this Classifier Instance that is an instance of the given Property.
ISlot	getSlot(java.lang.String name) Returns the Slot owned by this Classifier Instance with the given qualified or unqualified name.
ISlot	getSlot(java.lang.String uqName, IClassifier cls) Returns the Slot owned by this Classifier Instance with the given unqualified name.
ISlot	getSlot(java.lang.String uqName, java.lang.String clsFQName) Returns the Slot owned by this Classifier Instance with the given unqualified name.
java.util.List<ISlot>	getSlots() Returns the set of all Slots owned by this Classifier Instance.
boolean	isClassInstance() Is this Classifier Instance a Class Instance?
boolean	isDataTypeInstance() Is this Classifier Instance a Data Type Instance?
boolean	isDirectInstanceOf(IClassifier cl) Is this a direct instance of the given Classifier?
boolean	isDirectInstanceOf(java.lang.String classifierFQName) Is this a direct instance of the Classifier with the given fully qualified name?
boolean	isEqualTo(IClassifierInstance ci) Is this Classifier Instance equal to the given Classifier Instance? Semantic rules: 1.
boolean	isInstanceOf(IClassifier cl) Is this a direct or indirect instance of the given Classifier?
boolean	isInstanceOf(java.lang.String classifierFQName) Is this a direct or indirect instance of the Classifier with the given fully qualified name?
boolean	isMarkedAsDeleted() Is this Classifier Instance already marked as deleted - already visited by the recursive operation of deletion propagation?
IClassifierInstance	makeClone() Clones this Classifier Instance.
void	markAsDeleted() Deprecated.

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IRTElement

getMElement, hasIdentity

Methods inherited from interface rs.sol.soloist.server.uml.concepts.IElement

accept, accept, isKindOf, isModelElement, isRTElement

Method Detail

getMyID

long getMyID()

Returns unique identifier of this classifier instance.

isClassInstance

boolean isClassInstance()
                        throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Is this Classifier Instance a Class Instance?

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

isDataTypeInstance

boolean isDataTypeInstance()
                           throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Is this Classifier Instance a Data Type Instance?

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getClassifier

IClassifier getClassifier()
                          throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the Classifier of the UML model whose instance is this. Subsets element.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getClassifierFQName

java.lang.String getClassifierFQName()
                                     throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the fully qualified name of the instance's Classifier.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getClassifierUQName

java.lang.String getClassifierUQName()
                                     throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the unqualified name of the instance's Classifier.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

isInstanceOf

boolean isInstanceOf(IClassifier cl)
                     throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Is this a direct or indirect instance of the given Classifier?

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

isInstanceOf

boolean isInstanceOf(java.lang.String classifierFQName)
                     throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Is this a direct or indirect instance of the Classifier with the given fully qualified name?

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

isDirectInstanceOf

boolean isDirectInstanceOf(IClassifier cl)
                           throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Is this a direct instance of the given Classifier?

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

isDirectInstanceOf

boolean isDirectInstanceOf(java.lang.String classifierFQName)
                           throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Is this a direct instance of the Classifier with the given fully qualified name?

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

isEqualTo

boolean isEqualTo(IClassifierInstance ci)
                  throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Is this Classifier Instance equal to the given Classifier Instance?
Semantic rules:
1. If this and ci are instances of different kinds of Classifiers (one is an instance of a Class, and the other is an instance of a Data Type) they are different (not equal).
2. If this and ci refer to two different instances of Classes, they are different (not equal).
3. If this and ci refer to two instances of Data Types, their equality is checked on value basis (if all of their Slots are equal).

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getFirstCommonGeneralizer

IClassifier getFirstCommonGeneralizer(IClassifierInstance ci)
                                      throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the closest generalized Classifier of this and the given Classifier Instance.
If they have no common Classifiers, returns null.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getFirstCommonGeneralizerFQName

java.lang.String getFirstCommonGeneralizerFQName(IClassifierInstance ci)
                                                 throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the fully qualified name of the Classifier that is the closest generalized Classifier of this and the given Classifier Instance.
If they have no common Classifiers, returns null.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getFirstCommonGeneralizerUQName

java.lang.String getFirstCommonGeneralizerUQName(IClassifierInstance ci)
                                                 throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the unqualified name of the Classifier that is the closest generalized Classifier of this and the given Classifier Instance.
If they have no common Classifiers, returns null.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

conformsTo

boolean conformsTo(IClassifierInstance ci)
                   throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Does this Classifier Instance conform to the given one?
Relies on the same operation of the instances' Classifiers.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getSlots

java.util.List<ISlot> getSlots()
                               throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the set of all Slots owned by this Classifier Instance.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getSlot

ISlot getSlot(IProperty prop)
              throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the Slot owned by this Classifier Instance that is an instance of the given Property. Subsets slots.
Returns null if such does not exist (the Property is not a member of the Classifier of this Classifier Instance).

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getSlot

ISlot getSlot(java.lang.String name)

Returns the Slot owned by this Classifier Instance with the given qualified or unqualified name. Subsets slots.

In case oif unqualified name, the search by name for the Slot starts from the direct of this Classifier Instance.

Returns null if such does not exist.

getSlot

ISlot getSlot(java.lang.String uqName,
              IClassifier cls)
              throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the Slot owned by this Classifier Instance with the given unqualified name. Subsets slots.
The search by name for the Slot starts from the given Classifier upwards the generalization hierarchy; if it is is null, the search starts from the direct Classifier of this Classifier Instance.
Returns null if such does not exist.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getSlot

ISlot getSlot(java.lang.String uqName,
              java.lang.String clsFQName)
              throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the Slot owned by this Classifier Instance with the given unqualified name. Subsets slots.
The search by name for the Slot starts from the Classifier with the given fully qualified name upwards the generalization hierarchy; if it is is null, the search starts from the direct Classifier of this Classifier Instance.
Returns null if such does not exist.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getAttributeValues

java.util.List<IAttributeValue> getAttributeValues()
                                                   throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the set of all Attribute Values owned by this Classifier Instance. Subsets slots.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getAttributeValue

IAttributeValue getAttributeValue(IProperty prop)
                                  throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the Attribute Value owned by this Classifier Instance that is an instance of the given Property. Subsets attributeValues.
Returns null if such does not exist (the Property is not a member of the Classifier of this Classifier Instance or is not an attribute).

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getAttributeValue

IAttributeValue getAttributeValue(java.lang.String uqName,
                                  IClassifier cls)
                                  throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the Attribute Value owned by this Classifier Instance with the given unqualified name. Subsets attributeValues.
The search by name for the Attribute Value starts from the given Classifier upwards the generalization hierarchy; if it is is null, the search starts from the direct Classifier of this Classifier Instance.
Returns null if such does not exist.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

getAttributeValue

IAttributeValue getAttributeValue(java.lang.String uqName,
                                  java.lang.String clsFQName)
                                  throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Returns the Attribute Value owned by this Classifier Instance with the given unqualified name. Subsets attributeValues.
The search by name for the Attribute Value starts from the Classifier with the given fully qualified name upwards the generalization hierarchy; if it is is null, the search starts from the direct Classifier of this Classifier Instance.
Returns null if such does not exist.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

constructor

void constructor()
                 throws rs.sol.soloist.server.uml.exceptions.SOLoistException

The domain-specific constructor of the Classifier.

Throws:

rs.sol.soloist.server.uml.exceptions.SOLoistException

destructor

void destructor()
                throws rs.sol.soloist.server.uml.exceptions.SOLoistException

The domain-specific destructor of the Classifier.

Throws:

rs.sol.soloist.server.uml.exceptions.SOLoistException

isMarkedAsDeleted

boolean isMarkedAsDeleted()
                          throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Is this Classifier Instance already marked as deleted - already visited by the recursive operation of deletion propagation?

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

markAsDeleted

@Deprecated
void markAsDeleted()
                   throws rs.sol.soloist.server.uml.exceptions.RequestFailedException

Deprecated.

Marks this Classifier Instance as deleted, to prevent endless recursion of the operation of deletion propagation.

Throws:

rs.sol.soloist.server.uml.exceptions.RequestFailedException

destroy

void destroy()
             throws rs.sol.soloist.server.uml.exceptions.ActionExecutionFailedException

Destroys this Classifier Instance.
Always simply calls Actions::Action.destroyInstance(this).

Throws:

rs.sol.soloist.server.uml.exceptions.ActionExecutionFailedException

makeClone

IClassifierInstance makeClone()
                              throws rs.sol.soloist.server.uml.exceptions.ActionExecutionFailedException

Clones this Classifier Instance.

Throws:

rs.sol.soloist.server.uml.exceptions.ActionExecutionFailedException

copySlots

void copySlots(IClassifierInstance ciFrom,
               boolean toCopyAssociationEnds)
               throws rs.sol.soloist.server.uml.exceptions.ActionExecutionFailedException

Copies the values of all Slots of the given Classifier Instance ciFrom to the corresponding Slots (of the same Properties) of this Classifier Instance.
Always simply calls Actions::Action.copySlots(this,ciFrom,toCopyAssociationEnds).

Throws:

rs.sol.soloist.server.uml.exceptions.ActionExecutionFailedException

copySlots

void copySlots(IClassifierInstance ciFrom)
               throws rs.sol.soloist.server.uml.exceptions.ActionExecutionFailedException

Copies the values of all Slots of the given Classifier Instance ciFrom to the corresponding Slots (of the same Properties) of this Classifier Instance.
Simply calls copySlots(ciFrom, true).

Throws:

rs.sol.soloist.server.uml.exceptions.ActionExecutionFailedException