de.mid.innovator.srv2api.icw2class
Interface CLStructureDefinition

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

public interface CLStructureDefinition
extends CLClassifier, MEPackageAble, ELView, CLStructureElement


Nested Class Summary
static class CLStructureDefinition.VAttr
           
 
Method Summary
 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.
<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.
 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 de.mid.innovator.srv2api.icw2class.CLClassifier
dialogFolderRedefine, getAggregatedClassifier, getAggregatedClassifier, getAggregatedOrComposedClassifier, getAggregatedOrComposedClassifier, getAggregatingClassifier, getAggregatingClassifier, getAggregatingOrComposingClassifier, getAggregatingOrComposingClassifier, getClassifierInstance, getClassifierTemplateParameter, getComposedClassifier, getComposedClassifier, getComposingClassifier, getComposingClassifier, getContract, getContract, getContractSubstitution, getCreateObjectAction, getExceptionHandler, getInstSpec, getInterface, getOwnClass, getOwnedRule, getOwnedTemplateParameter, getOwnedUseCase, getProvidedInterface, getProvidedInterface, getProvidedInterfaceDirect, getProvidedInterfaceDirect, getRealizingClassifierRealization, getRequiredInterface, getRequiredInterface, getRequiredInterfaceDirect, getRequiredInterfaceDirect, getSubstitution, getTypedBCProperty, getTypedObjectNode, getTypedParameter, getTypedProperty, getTypedVariable, getUnmarshallAction, getUseCase
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble
getAssignedConstraint, getAssignedConstraint, getConstraintAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADVersionAble
getVersionFile, getVersionList, getVersionListWithoutOpenInfo
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADOptionAble
getOwnedOption, modifyOptionDlg
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADLockAble
getLock, getLockableCache, getLockLogin, getLockName, hasClutch, hasLock, hasNoLock, hasOthLock, hasOwnLock, isLockable, lock, unlock
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble
getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADAccessAble
getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAble
getMEOwnedMember, getMEPackageImport
 
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.ELValueContainerAble
getValueReUseAble, setValueReUseAble
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble
getAssignedComment, getAssignedComment, getCommentAssign
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADReferenceAble
getReferenceContainer, setReferenceContainer
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLTemplateAbleElement
getActualTemplateParameter, getActualTemplateParameter, getOwnedTemplateParameter, getTemplateBindingSource, getTemplateBindingTarget, getTemplateParameter
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLTemplateParameterAbleElement
getActualParameterSubstitution, getOwningTemplateParameter, getTemplateParameter
 
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
 
Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEPackageAble
getComponent, getManifest
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELView
hasDirectReferenceToClassifier, hasReferenceToClassifier
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.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, getItemDefinition, 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 de.mid.innovator.srv2api.icw2elem.ELRedefAble
getRedefined, getRedefining, isLeaf, isRedefined, isRedefining, setLeaf, setRedefined
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELType
getRaisingAsException, getTypedElement, getTypedElementNotAssocEnd, getTypedElementNotAssocEnd
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELViewGroupAble
getFeatureNotUsedByEntry, getFeatureNotUsedByEntry, getFeatureUsedByEntry, getFeatureUsedByEntry, getGroupType, getOwnedViewEntry, getOwnedViewGroup, getViewGroupClassifier, getXSDElemType, setGroupType, setViewGroupClassifier, setXSDElemType
 
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.icw2elem.ELViewElement
getConcreteExpression, getConcreteExpressionQuoted, getEnvironmentView, getModifyViewExpression, getPlaceholderExpression, getUsedFeature, modifyViewExpression, setConcreteExpression, setPlaceholderExpression, setUsedFeature
 
Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLStructureElement
createCopyFromGroupAble, createEntriesForClassifierFeatures, getNestedStructureElement, getNestedStructureElement, getShortName, removeEntriesForClassifierFeatures, setShortName
 
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.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.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
 

Method Detail

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.

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.

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

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