MESection (Java API)

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.icw2model
Interface MESection

All Superinterfaces:: ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADVersionAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELUUIDAble, ELValueContainerAble, MECommentAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MMAttachmentAble, MMLabelAble, MMLabelTextAttachmentAble, MMLocalizAble, MMTextAble

public interface MESection
extends MMLocalizAble, ADVersionAble, MENamespaceAble, MECommentAble, MENamespaceAsgnAble, MMLabelTextAttachmentAble
extends MMLocalizAble, ADVersionAble, MENamespaceAble, MECommentAble, MENamespaceAsgnAble, MMLabelTextAttachmentAble

Nested Class Summary
`static class`	`MESection.VAttr`

Method Summary

void assignSection(List<? extends ADClientAble> seqPart, boolean withHier)
Assign a list of elements to this section.

void assignSectionModel()
Assigns this section to the model as model section.

ARG_SectionClientExpandOut getClientExpand(List<? extends ADClientAble> seqAdd, List<? extends ADClientAble> seqRemove, List<? extends ADClientAble> seqContainer)
Expands the target MESection for client display.

List<MESection> getNestedSection(K_CONTROL_OPTION... behaviourFlags)
All sections owned by this section.

MESection getNestingSection()
The section owning this section.

ADXModel getOwningModel()
The model owning this section.





<T extends MM2Class> 


List<T>

getSectionClass(Class<T> returnType)
All meta classes allowed in this section.





<T extends ADLoginAble> 


List<T>

getSectionLoginAble(Class<T> returnType)
All users using this section.

ADXModel getSectionModel()
The model of this section.





<T extends ADClientAble> 


List<T>

getSectionPart(Class<T> returnType)
All parts of this section.

void removeFromSection(List<? extends ELElement> seq)
Removes all specified elements with all contents from this section and all nested sections.

void sectionDBMaintain()
Removes all database objects (DBTable and DBView) from this MESection, if there is no requirement EREntity in this section.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLocalizAble
`getOwnedLocaleName, hasAnyLocalizedName, hasLocalizedName`

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.icw2elem.ELPackageAble
`getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage`

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`

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.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.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.MECommentAble
`getAssignedComment, getAssignedComment, getCommentAssign`

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.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.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.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.icw2elem.ELValueContainerAble
`getValueReUseAble, setValueReUseAble`

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble
`getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment`

Method Detail

assignSection

void assignSection(List<? extends ADClientAble> seqPart,
                   boolean withHier)
                   throws InoNetException,
                          SrvErrorException

Assign a list of elements to this section. The list may be expanded to all containers of the specified elements.

Parameters:: seqPart - list of elements to be assigned; withHier - assign all container elements of the specified elements
Throws:: InoNetException; SrvErrorException

assignSectionModel

void assignSectionModel()
                        throws InoNetException,
                               SrvErrorException

Assigns this section to the model as model section.

Throws:: InoNetException; SrvErrorException

getClientExpand

ARG_SectionClientExpandOut getClientExpand(List<? extends ADClientAble> seqAdd,
                                           List<? extends ADClientAble> seqRemove,
                                           List<? extends ADClientAble> seqContainer)
                                           throws InoNetException,
                                                  SrvErrorException

Expands the target MESection for client display. That means, that the user choice of adding or removing elements will be expanded with corresponding elements.

Parameters:: seqAdd - list of elements for adding; seqRemove - list of elements for removing; seqContainer - list of container elements already part of the section but containing elements for adding or removing
Throws:: InoNetException; SrvErrorException

getNestedSection

List<MESection> getNestedSection(K_CONTROL_OPTION... behaviourFlags)
                                 throws InoNetException,
                                        SrvErrorException

All sections owned by this section.

Parameters:: behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:: InoNetException; SrvErrorException

getNestingSection

MESection getNestingSection()
                            throws InoNetException,
                                   SrvErrorException

The section owning this section.

Throws:: InoNetException; SrvErrorException

getOwningModel

ADXModel getOwningModel()
                        throws InoNetException,
                               SrvErrorException

The model owning this section.

Throws:: InoNetException; SrvErrorException

getSectionClass

<T extends MM2Class> List<T> getSectionClass(Class<T> returnType)
                                         throws InoNetException,
                                                SrvErrorException

All meta classes allowed in this section.

Parameters:: returnType - Specifies the type of elements to be returned.
Throws:: InoNetException; SrvErrorException

getSectionLoginAble

<T extends ADLoginAble> List<T> getSectionLoginAble(Class<T> returnType)
                                                throws InoNetException,
                                                       SrvErrorException

All users using this section.

Parameters:: returnType - Specifies the type of elements to be returned.
Throws:: InoNetException; SrvErrorException

getSectionModel

ADXModel getSectionModel()
                         throws InoNetException,
                                SrvErrorException

The model of this section.

Throws:: InoNetException; SrvErrorException

getSectionPart

<T extends ADClientAble> List<T> getSectionPart(Class<T> returnType)
                                            throws InoNetException,
                                                   SrvErrorException

All parts of this section.

Parameters:: returnType - Specifies the type of elements to be returned.
Throws:: InoNetException; SrvErrorException

removeFromSection

void removeFromSection(List<? extends ELElement> seq)
                       throws InoNetException,
                              SrvErrorException

Removes all specified elements with all contents from this section and all nested sections.

Parameters:: seq - List of ELElement
Throws:: InoNetException; SrvErrorException

sectionDBMaintain

void sectionDBMaintain()
                       throws InoNetException,
                              SrvErrorException

Removes all database objects (DBTable and DBView) from this MESection, if there is no requirement EREntity in this section. If section is a sub-section, this method completes the assignment of database objects to this section according to the entites of this section and the database objects (DBTable and DBView) assigned to the super-section.

Throws:: InoNetException; SrvErrorException