Interface CLInstSpec

All Superinterfaces:

ADClientAble, ADFindAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELUUIDAble, ELValueContainerAble, ELValueReUseAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

All Known Subinterfaces:

CLEnumLiteral, CLInstanceSpecification

public interface CLInstSpec
extends ELNamespaceAble, MEConstraintAble, MEPackageAble, MEStereotypeAble, MECommentAble, ELValueReUseAble, MMLabelTextAttachmentAble

This is a utility class for CLInstSpec that provides static methods for creation or other purposes.

Note:

The interface CLInstSpec describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CLInstSpec.VAttr

Method Summary

Modifier and Type	Method	Description
<T extends CLClassifier> List<T>	getClassifier(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	The classifier/s of the represented instance.
<T extends CLInstSpec> List<T>	getConnectedInstance(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All instance specifications which are connected to this link instance.
<T extends CLInstSpec> List<T>	getConnectedInstance(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getConnectedInstance and filters its return values according to the given stereotype value.
<T extends CLInstSpec> List<T>	getConnectedLink(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All links which are connected to this instance specification.
<T extends CLInstSpec> List<T>	getConnectedLink(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getConnectedLink and filters its return values according to the given stereotype value.
<T extends CLInstSpec> List<T>	getOppositeConnectedInstance(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All instance specifications on the opposite side of a connected link instance of this instance specification.
<T extends CLInstSpec> List<T>	getOppositeConnectedInstance(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getOppositeConnectedInstance and filters its return values according to the given stereotype value.
List<CLSlot>	getSlot(K_CONTROL_OPTION... behaviourFlags)	A slot giving the value or values of a structural feature of the instance.
ELValSpec	getSpecification()	A specification of how to compute, derive or construct the instance.
String	getSpecificationBody()	The specification expression of how to compute, derive or construct the instance.
String	getSpecificationLanguage()	The language of the specification expression of how to compute, derive or construct the instance.
List<ELValSpecInstVal>	getValSpecInstVal()	All values which specifiy the instance.
void	setClassifier(List<? extends CLClassifier> values)	Set the value of Foreign Key Classifier.
void	setSpecificationBody(String value)	Set the value of Info SpecificationBody.
void	setSpecificationLanguage(String value)	Set the value of Info SpecificationLanguage.

Methods inherited from interface ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface ELDeleteAble

delete

Methods inherited from interface ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getItemDefinition, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface ELPackageAble

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface ELValueReUseAble

getValueContainerAble

Methods inherited from interface MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getDataModel, getDataModelName, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface MENamespaceAsgnAble

getSignatureMessage

Methods inherited from interface MEPackageAble

getComponent, getManifest

Methods inherited from interface MEStereotypeAble

getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getMEClientDependency, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface METermAble

getTerm, setTerm

Methods inherited from interface MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getExtendingStereotype, getExtendingStereotypeNames, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setExtendingStereotype, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getText, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Details

getSpecificationBody

String getSpecificationBody()
                     throws InoNetException,
SrvErrorException

The specification expression of how to compute, derive or construct the instance.

Throws:

InoNetException

SrvErrorException

setSpecificationBody

void setSpecificationBody(String value)
                   throws InoNetException,
SrvErrorException

Set the value of Info SpecificationBody.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getSpecificationLanguage

String getSpecificationLanguage()
                         throws InoNetException,
SrvErrorException

The language of the specification expression of how to compute, derive or construct the instance.

Throws:

InoNetException

SrvErrorException

setSpecificationLanguage

void setSpecificationLanguage(String value)
                       throws InoNetException,
SrvErrorException

Set the value of Info SpecificationLanguage.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getConnectedInstance

<T extends CLInstSpec> List<T> getConnectedInstance(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
SrvErrorException

All instance specifications which are connected to this link instance.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getConnectedInstance

<T extends CLInstSpec> List<T> getConnectedInstance(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
SrvErrorException

The method calls getConnectedInstance and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getConnectedLink

<T extends CLInstSpec> List<T> getConnectedLink(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                         throws InoNetException,
SrvErrorException

All links which are connected to this instance specification.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getConnectedLink

<T extends CLInstSpec> List<T> getConnectedLink(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                         throws InoNetException,
SrvErrorException

The method calls getConnectedLink and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getOppositeConnectedInstance

<T extends CLInstSpec> List<T> getOppositeConnectedInstance(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                                     throws InoNetException,
SrvErrorException

All instance specifications on the opposite side of a connected link instance of this instance specification.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getOppositeConnectedInstance

<T extends CLInstSpec> List<T> getOppositeConnectedInstance(Class<T> returnType,
 MMStereotype stereotype,
 K_CONTROL_OPTION... behaviourFlags)
                                                     throws InoNetException,
SrvErrorException

The method calls getOppositeConnectedInstance and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getClassifier

<T extends CLClassifier> List<T> getClassifier(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                        throws InoNetException,
SrvErrorException

The classifier/s of the represented instance. If multiple classifiers are specified, the instance is classified by all of them.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

setClassifier

void setClassifier(List<? extends CLClassifier> values)
            throws InoNetException,
SrvErrorException

Set the value of Foreign Key Classifier.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

getValSpecInstVal

List<ELValSpecInstVal> getValSpecInstVal()
                                  throws InoNetException,
SrvErrorException

All values which specifiy the instance.

Throws:

InoNetException

SrvErrorException

getSlot

List<CLSlot> getSlot(K_CONTROL_OPTION... behaviourFlags)
              throws InoNetException,
SrvErrorException

A slot giving the value or values of a structural feature of the instance. An instance specification can have one slot per structural feature of its classifiers, including inherited features. It is not necessary to model a slot for each structural feature, in which case the instance specification is a partial description.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getSpecification

ELValSpec getSpecification()
                    throws InoNetException,
SrvErrorException

A specification of how to compute, derive or construct the instance.

Throws:

InoNetException

SrvErrorException