Package de.mid.innovator.srv2api.icw2class

Interface CLStructureElement

All Superinterfaces:

ADClientAble, ADM2AttrModifyAble, CLValueRangeAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELShortNameAble, ELUUIDAble, ELViewElement, MEModelElement, MENamedElement, MENamespaceAsgnAble

All Known Subinterfaces:

CLStructureDefinition, CLStructureEntry, CLStructureGroup

public interface CLStructureElement
extends MENamespaceAsgnAble, ELViewElement, CLValueRangeAble, ELShortNameAble

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

See Also:

CLStructureElementHelper

Note:

The interface CLStructureElement 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 class	CLStructureElement.VAttr

Method Summary

Modifier and Type	Method	Description
java.util.List<CLStructureElement>	createCopyFromGroupAble(ELViewGroupAble ohGroupAble, boolean copyRecursive, boolean useInGroup, ARG_StereotypeRelationsOut valStereoRel)	Creates a group as copy of the specified group and entries for each contained entry.
java.util.List<CLStructureElement>	createEntriesForClassifierFeatures(ELClassifier ohClassifier)	Creates an entry for each feature of the classifier.
<T extends CLStructureElement> java.util.List<T>	getNestedStructureElement(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All structure elements being contained in this structure element.
<T extends CLStructureElement> java.util.List<T>	getNestedStructureElement(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getNestedStructureElement and filters its return values according to the given stereotype value.
java.lang.String	getTypeLanguage()	The attribute identifies the type language used to specify the base type of this CLStructureElement.
boolean	isCollection()	Setting this flag to true indicates that the actual values defined by this CLStructureElement are collections of allowed values.
void	removeEntriesForClassifierFeatures(ELClassifier ohClassifier)	Removes all the entries using the features of the classifier.
void	setCollection(boolean value)	Set the value of Attribut IsCollection.
void	setTypeLanguage(java.lang.String value)	Set the value of Attribut TypeLanguage.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

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

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.icw2class.CLValueRangeAble

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

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

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

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.ELDeleteAble

delete

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.ELNamedElement

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

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.icw2elem.ELObject

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

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELShortNameAble

getShortName, setShortName

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELViewElement

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

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.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Method Detail

isCollection

boolean isCollection()
              throws InoNetException,
                     SrvErrorException

Setting this flag to true indicates that the actual values defined by this CLStructureElement are collections of allowed values. The default is false.

Throws:

InoNetException

SrvErrorException

setCollection

void setCollection(boolean value)
            throws InoNetException,
                   SrvErrorException

Set the value of Attribut IsCollection.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getTypeLanguage

java.lang.String getTypeLanguage()
                          throws InoNetException,
                                 SrvErrorException

The attribute identifies the type language used to specify the base type of this CLStructureElement. The language SHALL be specified in a URI format.

Throws:

InoNetException

SrvErrorException

setTypeLanguage

void setTypeLanguage(java.lang.String value)
              throws InoNetException,
                     SrvErrorException

Set the value of Attribut TypeLanguage.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getNestedStructureElement

<T extends CLStructureElement> java.util.List<T> getNestedStructureElement(java.lang.Class<T> returnType,
                                                                           K_CONTROL_OPTION... behaviourFlags)
                                                                    throws InoNetException,
                                                                           SrvErrorException

All structure elements being contained in this structure element. If the element is not a grouping element the list of elements returned will be empty.

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

Sorted:

getNestedStructureElement

<T extends CLStructureElement> java.util.List<T> getNestedStructureElement(java.lang.Class<T> returnType,
                                                                           MMStereotype stereotype,
                                                                           K_CONTROL_OPTION... behaviourFlags)
                                                                    throws InoNetException,
                                                                           SrvErrorException

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

createCopyFromGroupAble

java.util.List<CLStructureElement> createCopyFromGroupAble(ELViewGroupAble ohGroupAble,
                                                           boolean copyRecursive,
                                                           boolean useInGroup,
                                                           ARG_StereotypeRelationsOut valStereoRel)
                                                    throws InoNetException,
                                                           SrvErrorException

Creates a group as copy of the specified group and entries for each contained entry. If the specified group is of type classifier the new group will be connected to this classifier. Each entry is directly connected to the feature it uses.

Parameters:

ohGroupAble - group able element

copyRecursive - true, if view groups are copied recursive

useInGroup - true, if ohIn is used as first group, otherwise a new group is created

valStereoRel - configured stereotype relationships

Throws:

InoNetException

SrvErrorException

createEntriesForClassifierFeatures

java.util.List<CLStructureElement> createEntriesForClassifierFeatures(ELClassifier ohClassifier)
                                                               throws InoNetException,
                                                                      SrvErrorException

Creates an entry for each feature of the classifier. Each entry is directly connected to the feature it uses. If a feature is already used by a direct entry of the structure no entry will be created.

Parameters:

ohClassifier - classifier which contains useable features

Throws:

InoNetException

SrvErrorException

removeEntriesForClassifierFeatures

void removeEntriesForClassifierFeatures(ELClassifier ohClassifier)
                                 throws InoNetException,
                                        SrvErrorException

Removes all the entries using the features of the classifier.

Parameters:

ohClassifier - classifier which contains useable features

Throws:

InoNetException

SrvErrorException