Overview  Package   Class  Use  Help 
SDK Help DE  EN
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

de.mid.innovator.srv2api.icw2class
Interface CLStructureElement

All Superinterfaces:
ADClientAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELUUIDAble, ELViewElement, MEModelElement, MENamedElement, MENamespaceAsgnAble
All Known Subinterfaces:
CLStructureDefinition, CLStructureEntry, CLStructureGroup
public interface CLStructureElement
extends MENamespaceAsgnAble, ELViewElement

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
static class CLStructureElement.VAttr
           
 
Method Summary
 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.
 List<CLStructureElement> createEntriesForClassifierFeatures(ELClassifier ohClassifier)
          Creates an entry for each feature of the classifier.
<T extends CLStructureElement>
List<T>
getNestedStructureElement(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)
          All structure elements being contained in this structure element.
<T extends CLStructureElement>
List<T>
getNestedStructureElement(Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getNestedStructureElement and filters its return values according to the given stereotype value.
 String getShortName()
          Short name of this CLStructureElement.
 void removeEntriesForClassifierFeatures(ELClassifier ohClassifier)
          Removes all the entries using the features of the classifier.
 void setShortName(String value)
          Set the value of Attribut ShortName.
 
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.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.ELViewElement
getConcreteExpression, getConcreteExpressionQuoted, getEnvironmentView, getModifyViewExpression, getPlaceholderExpression, getUsedFeature, modifyViewExpression, setConcreteExpression, setPlaceholderExpression, setUsedFeature
 
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.ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName
 

Method Detail

createCopyFromGroupAble

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

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

getNestedStructureElement

<T extends CLStructureElement> List<T> getNestedStructureElement(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> List<T> getNestedStructureElement(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

getShortName

String getShortName()
                    throws InoNetException,
                           SrvErrorException
Short name of this CLStructureElement.

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

setShortName

void setShortName(String value)
                  throws InoNetException,
                         SrvErrorException
Set the value of Attribut ShortName.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException
Overview  Package   Class  Use  Help 
SDK Help DE  EN
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

© MID GmbH, All rights reserved.