de.mid.innovator.srv2api.icw2class
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, 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
static class CLInstSpec.VAttr
           
 
Method Summary
<T extends CLClassifier>
List<T>
getClassifier(Class<T> returnType)
          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 de.mid.innovator.srv2api.icw2elem.ELNamespaceAble
getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEPackageAble
getComponent, getManifest
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELPackageAble
getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble
getMENamespace
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble
getUUID, setUUID
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble
getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement
getMESupplierDependency, getMESupplierMappingDependency
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement
buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble
getCheckSetNotToLocalizeAttribute, getClientDependency, getNotToLocalizeAttribute, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedLocalizedValue, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, resetNotToLocalizeAttribute, setNotToLocalizeAttribute, sortContents
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble
delete
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble
getAnnotation, getLogic, getLogic, getPresentationContext, getSection
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble
getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRowList, getTabElementRowTypeList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement
duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject
getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble
getClientMappingDependency, getOutgoingConceptRealization, getProxyAsgProperty, getRealizedConcept, getRealizedConcept, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, replaceRealizedConcepts, setMapped, setRealizedConcept, setRequirementOfStakeholder
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble
getOwnedComment
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble
assignStereotypeDlg, cloneElement, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, isCloneAbleElement, modifyStereotypePropertyValuesByName, setStereotype, setStereotypePropertyInfo
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble
getValueReUseAble, setValueReUseAble
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueReUseAble
getValueContainerAble
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble
getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble
getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble
getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment
 

Method Detail

getClassifier

<T extends CLClassifier> List<T> getClassifier(Class<T> returnType)
                                           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.
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

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

getSpecificationBody

String getSpecificationBody()
                            throws InoNetException,
                                   SrvErrorException
The specification expression of how to compute, derive or construct the instance.

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

getValSpecInstVal

List<ELValSpecInstVal> getValSpecInstVal()
                                         throws InoNetException,
                                                SrvErrorException
All values which specifiy the instance.

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

setSpecificationBody

void setSpecificationBody(String value)
                          throws InoNetException,
                                 SrvErrorException
Set the value of Info SpecificationBody.

Parameters:
value - The value to be set.
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