Package de.mid.innovator.srv2api.icw2dg

Interface DGSelection

All Superinterfaces:

ADClientAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELUUIDAble, MMLocalizAble, MMMetamodelElement

public interface DGSelection
extends MMMetamodelElement, MMLocalizAble

A documentation selection links a documentation structure to layout information such as title page, header information, footer information and documentation configuration. It is used by a documentation command.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DGSelection.VAttr

Method Summary

Modifier and Type	Method	Description
DGFooter	getCFooter()	The footer of the toc of this selection.
DGHeader	getCHeader()	The header of the toc of this selection.
DGConfig	getConfig()	The configuration of this selection.
java.util.List<DGCommand>	getDocuCommand(K_CONTROL_OPTION... behaviourFlags)	All docu commands owned by this documentation selection.
DGDocuStructureRoot	getDocuStructureRoot()	The documentation structure used by this documentation selection.
DGFooter	getMFooter()	The footer of the main text of this selection.
DGHeader	getMHeader()	The header of the main text of this selection.
MMProfile	getOwningProfile()	The profile that owns this documentation selection.
DGTitle	getTitle()	The title of this selection.
void	setCFooter(DGFooter value)	Set the value of Foreign Key CFooter.
void	setCHeader(DGHeader value)	Set the value of Foreign Key CHeader.
void	setConfig(DGConfig value)	Set the value of Foreign Key Config.
void	setDocuStructureRoot(DGDocuStructureRoot value)	Set the value of Foreign Key DocuStructureRoot.
void	setMFooter(DGFooter value)	Set the value of Foreign Key MFooter.
void	setMHeader(DGHeader value)	Set the value of Foreign Key MHeader.
void	setTitle(DGTitle value)	Set the value of Foreign Key Title.

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

getHyperlinkReferenceAble, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

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

hasAnyLocalizedName, hasLocalizedName

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

getIgnoringProfile

Method Detail

getTitle

DGTitle getTitle()
          throws InoNetException,
                 SrvErrorException

The title of this selection.

Throws:

InoNetException

SrvErrorException

setTitle

void setTitle(DGTitle value)
       throws InoNetException,
              SrvErrorException

Set the value of Foreign Key Title.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMHeader

DGHeader getMHeader()
             throws InoNetException,
                    SrvErrorException

The header of the main text of this selection.

Throws:

InoNetException

SrvErrorException

setMHeader

void setMHeader(DGHeader value)
         throws InoNetException,
                SrvErrorException

Set the value of Foreign Key MHeader.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMFooter

DGFooter getMFooter()
             throws InoNetException,
                    SrvErrorException

The footer of the main text of this selection.

Throws:

InoNetException

SrvErrorException

setMFooter

void setMFooter(DGFooter value)
         throws InoNetException,
                SrvErrorException

Set the value of Foreign Key MFooter.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getCHeader

DGHeader getCHeader()
             throws InoNetException,
                    SrvErrorException

The header of the toc of this selection.

Throws:

InoNetException

SrvErrorException

setCHeader

void setCHeader(DGHeader value)
         throws InoNetException,
                SrvErrorException

Set the value of Foreign Key CHeader.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getCFooter

DGFooter getCFooter()
             throws InoNetException,
                    SrvErrorException

The footer of the toc of this selection.

Throws:

InoNetException

SrvErrorException

setCFooter

void setCFooter(DGFooter value)
         throws InoNetException,
                SrvErrorException

Set the value of Foreign Key CFooter.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getConfig

DGConfig getConfig()
            throws InoNetException,
                   SrvErrorException

The configuration of this selection.

Throws:

InoNetException

SrvErrorException

setConfig

void setConfig(DGConfig value)
        throws InoNetException,
               SrvErrorException

Set the value of Foreign Key Config.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getDocuCommand

java.util.List<DGCommand> getDocuCommand(K_CONTROL_OPTION... behaviourFlags)
                                  throws InoNetException,
                                         SrvErrorException

All docu commands owned by this documentation selection.

Parameters:

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

Throws:

InoNetException

SrvErrorException

getDocuStructureRoot

DGDocuStructureRoot getDocuStructureRoot()
                                  throws InoNetException,
                                         SrvErrorException

The documentation structure used by this documentation selection.

Throws:

InoNetException

SrvErrorException

setDocuStructureRoot

void setDocuStructureRoot(DGDocuStructureRoot value)
                   throws InoNetException,
                          SrvErrorException

Set the value of Foreign Key DocuStructureRoot.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getOwningProfile

MMProfile getOwningProfile()
                    throws InoNetException,
                           SrvErrorException

The profile that owns this documentation selection.

Throws:

InoNetException

SrvErrorException