Interface CLStructureDefinition

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, CLClassifier, CLStructureElement, CLTemplateAbleElement, CLTemplateParameterAbleElement, CLValueRangeAble, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELRedefAble, ELShortNameAble, ELType, ELUUIDAble, ELValueContainerAble, ELView, ELViewElement, ELViewGroupAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, METermAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface CLStructureDefinition
extends CLClassifier, MEPackageAble, ELView, CLStructureElement

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CLStructureDefinition.VAttr

Method Summary

Modifier and Type	Method	Description
List<CLStructureDefinition>	getNestedStructuredDefinition(K_CONTROL_OPTION... behaviourFlags)	References all the structure definitions that are defined (nested) within this CLStructureDefinition.
List<CLStructureEntry>	getOwnedStructureEntry(K_CONTROL_OPTION... behaviourFlags)	All structure entries owned by this structure definition.
List<CLStructureGroup>	getOwnedStructureGroup(K_CONTROL_OPTION... behaviourFlags)	All structure groups owned by this structure definition.
MMProfile	getOwningProfile()	The MMProfile owning this CLStructureDefinition.
<T extends CLStructureElement> List<T>	getStructureContentNecessaryForFeature(Class<T> returnType, ELFeature refObj, K_CONTROL_OPTION... behaviourFlags)	All structure entries and their owners which are directly derived from the given feature.
<T extends CLStructureElement> List<T>	getStructureContentNecessaryForFeature(Class<T> returnType, MMStereotype stereotype, ELFeature refObj, K_CONTROL_OPTION... behaviourFlags)	The method calls getStructureContentNecessaryForFeature and filters its return values according to the given stereotype value.
<T extends CLStructureElement> List<T>	getStructureContentNecessaryForGroup(Class<T> returnType, CLStructureGroup refObj, K_CONTROL_OPTION... behaviourFlags)	All structure groups, their content and their owners which are directly derived from the given group.
<T extends CLStructureElement> List<T>	getStructureContentNecessaryForGroup(Class<T> returnType, MMStereotype stereotype, CLStructureGroup refObj, K_CONTROL_OPTION... behaviourFlags)	The method calls getStructureContentNecessaryForGroup and filters its return values according to the given stereotype value.
List<DMTypedChildExpression>	getTypedChildExpression()	All DMChildExpression typed by this CLStructureDefinition.
boolean	isExactViewOfSingleStructurePart(ADClientAble refObj)	Returns True of the structure definition can be seen as a complete reproduction of the structure element passed.

Methods inherited from interface ADAccessAble

getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole

Methods inherited from interface ADClientAble

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

Methods inherited from interface ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface ADLockAble

getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock

Methods inherited from interface ADM2AttrModifyAble

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

Methods inherited from interface ADOptionAble

getOwnedOption, modifyOptionDlg

Methods inherited from interface ADReferenceAble

getReferenceContainer, setReferenceContainer

Methods inherited from interface ADVersionAble

getVersionFile, getVersionList, getVersionListWithoutOpenInfo

Methods inherited from interface CLClassifier

dialogFolderRedefine, getAggregatedClassifier, getAggregatedClassifier, getAggregatedOrComposedClassifier, getAggregatedOrComposedClassifier, getAggregatingClassifier, getAggregatingClassifier, getAggregatingOrComposingClassifier, getAggregatingOrComposingClassifier, getClassifierInstance, getClassifierTemplateParameter, getComposedClassifier, getComposedClassifier, getComposingClassifier, getComposingClassifier, getContract, getContract, getCreateObjectAction, getExceptionHandler, getInstSpec, getInterface, getOwnClass, getOwnedRule, getOwnedTemplateParameter, getOwnedUseCase, getProvidedInterface, getProvidedInterface, getProvidedInterfaceDirect, getProvidedInterfaceDirect, getRealizingClassifierRealization, getRequiredInterface, getRequiredInterface, getRequiredInterfaceDirect, getRequiredInterfaceDirect, getSubstitution, getTypedBCProperty, getTypedObjectNode, getTypedParameter, getTypedProperty, getTypedPropertyNotAssocEnd, getTypedVariable, getTypedVariableDRGElement, getTypedVariableDRGElement, getUnmarshallAction, getUseCase

Methods inherited from interface CLStructureElement

createCopyFromGroupAble, createEntriesForClassifierFeatures, getNestedStructureElement, getNestedStructureElement, getTypeLanguage, isCollection, removeEntriesForClassifierFeatures, setCollection, setTypeLanguage

Methods inherited from interface CLTemplateAbleElement

getActualTemplateParameter, getActualTemplateParameter, getOwnedTemplateParameter, getTemplateBindingSource, getTemplateBindingTarget, getTemplateParameter

Methods inherited from interface CLTemplateParameterAbleElement

getActualParameterSubstitution, getTemplateParameter

Methods inherited from interface CLValueRangeAble

createRangeValue, deleteRangeValue, getModifyValueRangeList, getOwnedTypeRestriction, getOwnedValueRange, getOwnedValueRestriction, getRangeValues, getTypeRestrictionSpecification, getValueRangeAsString, getValueRestrictionLanguage, getValueRestrictionSpecification, mergeRangeValues, modifyRangeValue, modifyValueRangeList, setTypeRestrictionSpecification, setValueRangeAsString, setValueRestrictionLanguage, setValueRestrictionSpecification

Methods inherited from interface ELClassifier

getAssociation, getAssociation, getAssociationEndFirstTypedBySelf, getAssociationEndFirstTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelf, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndNavigableTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelf, getAssociationEndTypedBySelf, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationEndTypedBySelfOrGeneralTransitive, getAssociationNavigableFrom, getAssociationNavigableFrom, getAssociationOfSelfOrGeneralTransitive, getAssociationOfSelfOrGeneralTransitive, getAssociationTypedBySelf, getAssociationTypedBySelf, getClassifierViewGroup, getEffectiveRedefinerOfAssocEnd, getEffectiveRedefinerOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getEffectiveSubsetterOfAssocEnd, getGeneralDirect, getGeneralDirect, getGeneralGeneralizationSet, getGeneralGeneralizationSet, getGeneralization, getGeneralTransitive, getGeneralTransitive, getOwnedAndInheritedMember, getOwnedAndInheritedMember, getPropertyNavigableFrom, getPropertyNavigableFrom, getPropertyNavigableFromSelfOrGeneralTransitive, getPropertyNavigableFromSelfOrGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndGeneralTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitive, getSelfAndSpecificTransitiveNotAbstract, getSelfAndSpecificTransitiveNotAbstract, getSpecialization, getSpecificDirect, getSpecificDirect, getSpecificGeneralization, getSpecificGeneralizationSet, getSpecificGeneralizationSet, getSpecificTransitive, getSpecificTransitive, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstract, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractRange, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getSpecificTransitiveNotAbstractTypesOfEffectiveSubsetterOfAssocEndIntersectedByInverseAssocEnd, getTypedCLStructureEntry, getTypedMaskField, getTypesOfEffectiveSubsetterOfAssocEnd, getTypesOfEffectiveSubsetterOfAssocEnd, getViewTransitive, getViewTransitive, isAbstract, isRoot, isSpecificTransitive, setAbstract

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 ELRedefAble

getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined

Methods inherited from interface ELShortNameAble

getShortName, getShortNameKind, setShortName, setShortNameKind, setUniqueShortName

Methods inherited from interface ELType

getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd, isTypeReuseable

Methods inherited from interface ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface ELView

hasDirectReferenceToClassifier, hasReferenceToClassifier, isReadOnly, setReadOnly

Methods inherited from interface ELViewElement

getConcreteExpression, getConcreteExpressionQuoted, getEnvironmentView, getExprFlowText, getExprInnoRefText, getExprText, getModifyViewExpressionFlow, getUsedFeature, modifyViewExpressionFlow, setConcreteExpression, setExprFlowText, setExprInnoRefText, setUsedFeature

Methods inherited from interface ELViewGroupAble

getFeatureNotUsedByEntry, getFeatureNotUsedByEntry, getFeatureUsedByEntry, getFeatureUsedByEntry, getGroupType, getOwnedViewEntry, getOwnedViewGroup, getViewGroupClassifier, getXSDElemType, setGroupType, setViewGroupClassifier, setXSDElemType

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 MENamespaceAble

getMEOwnedMember, getMEPackageImport

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

isExactViewOfSingleStructurePart

boolean isExactViewOfSingleStructurePart(ADClientAble refObj)
                                  throws InoNetException,
SrvErrorException

Returns True of the structure definition can be seen as a complete reproduction of the structure element passed.

Parameters:

refObj - A further instance of type ADClientAble which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

getStructureContentNecessaryForFeature

<T extends CLStructureElement> List<T> getStructureContentNecessaryForFeature(Class<T> returnType,
 ELFeature refObj,
 K_CONTROL_OPTION... behaviourFlags)
                                                                       throws InoNetException,
SrvErrorException

All structure entries and their owners which are directly derived from the given feature.

Parameters:

returnType - Specifies the type of elements to be returned.

refObj - A further instance of type ELFeature which is used to control the behaviour of the method. (see description above)

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

Throws:

InoNetException

SrvErrorException

getStructureContentNecessaryForFeature

<T extends CLStructureElement> List<T> getStructureContentNecessaryForFeature(Class<T> returnType,
 MMStereotype stereotype,
 ELFeature refObj,
 K_CONTROL_OPTION... behaviourFlags)
                                                                       throws InoNetException,
SrvErrorException

The method calls getStructureContentNecessaryForFeature 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

refObj - A further instance of type ELFeature which is used to control the behaviour of the method. (see description above)

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

Throws:

InoNetException

SrvErrorException

getStructureContentNecessaryForGroup

<T extends CLStructureElement> List<T> getStructureContentNecessaryForGroup(Class<T> returnType,
 CLStructureGroup refObj,
 K_CONTROL_OPTION... behaviourFlags)
                                                                     throws InoNetException,
SrvErrorException

All structure groups, their content and their owners which are directly derived from the given group.

Parameters:

returnType - Specifies the type of elements to be returned.

refObj - A further instance of type CLStructureGroup which is used to control the behaviour of the method. (see description above)

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

Throws:

InoNetException

SrvErrorException

getStructureContentNecessaryForGroup

<T extends CLStructureElement> List<T> getStructureContentNecessaryForGroup(Class<T> returnType,
 MMStereotype stereotype,
 CLStructureGroup refObj,
 K_CONTROL_OPTION... behaviourFlags)
                                                                     throws InoNetException,
SrvErrorException

The method calls getStructureContentNecessaryForGroup 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

refObj - A further instance of type CLStructureGroup which is used to control the behaviour of the method. (see description above)

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

Throws:

InoNetException

SrvErrorException

getOwnedStructureGroup

List<CLStructureGroup> getOwnedStructureGroup(K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
SrvErrorException

All structure groups owned by this structure definition.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getOwnedStructureEntry

List<CLStructureEntry> getOwnedStructureEntry(K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
SrvErrorException

All structure entries owned by this structure definition.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getNestedStructuredDefinition

List<CLStructureDefinition> getNestedStructuredDefinition(K_CONTROL_OPTION... behaviourFlags)
                                                   throws InoNetException,
SrvErrorException

References all the structure definitions that are defined (nested) within this CLStructureDefinition.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getTypedChildExpression

List<DMTypedChildExpression> getTypedChildExpression()
                                              throws InoNetException,
SrvErrorException

All DMChildExpression typed by this CLStructureDefinition.

Throws:

InoNetException

SrvErrorException

getOwningProfile

MMProfile getOwningProfile()
                    throws InoNetException,
SrvErrorException

The MMProfile owning this CLStructureDefinition.

Throws:

InoNetException

SrvErrorException