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.icw2dg
Interface DGCommand

All Superinterfaces:
ADClientAble, ADExecuteAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELPresOptAble, ELUUIDAble, MMLocalizAble, MMLocalizedPropertyAble, MMMenuItemAble, MMMetaCommentAble, MMMetamodelElement
public interface DGCommand
extends ELUUIDAble, MMMenuItemAble, ADExecuteAble

Represents a documentation command. A command contains information about the output format, graphic format and other informations needed for generating a documentation.

Nested Class Summary
static class DGCommand.VAttr
           
 
Method Summary
 ARG_DocuOut executeDocu(List<? extends ELElement> seq)
          Execute a Documentation Command on the server.
 K_DOCU_CHANGE_CHAPTER_MODE getChangeChapterHeadings()
          Specifies which chapter headings are converted to dash lists.
 boolean getCheckInput(List<? extends ELElement> seq)
          Checks wether this documentation command can produces output with the current selection.
 List<ELValSpecString> getClassPathValue(K_CONTROL_OPTION... behaviourFlags)
          All string values of class paths owned by this documentation command.
 DGSelection getDGSelection()
          The documentation selection that owns this docu command.
 K_DOCU_GRAPHIC_FORMAT getGraphicFormat()
          Format of graphics.
 boolean getLeastCommonPackage()
          Use least common package as root of documentation.
 boolean getNoMultiPageGraphics()
          Collate multi-paged graphics.
 K_DOCU_OPEN_MODE getOpenMode()
          Specifies if the generated documentation is opened.
 String getOutputDirectory()
          Directory path for generated files.
 K_DOCU_TYPE getOutputKind()
          Kind of output.
 String getOutputRepositories()
          Name used for repository files.
 boolean getPerformInputCheck()
          Perform an input check before documentation generation.
 String getPostprocessingArguments()
          The arguments of the postprocessing command.
 String getPostprocessingCommand()
          The postprocessing command of this documentation command.
 String getPrinterName()
          The printer to be used.
 MMProfile getProfile()
          The profile that owns this docu command.
 boolean getRemoveEmptyChapters()
          Remove empty chapters.
 String getReportCommand()
          The java command called if the postprocessing command is inojava.
 String getSearchName()
          Search, which is executed before documentation generation, in order to determine the selection.
 String getSearchPath()
          Search path for include and imports.
 List<ELValSpecString> getVirtualMachineValue(K_CONTROL_OPTION... behaviourFlags)
          All string values of virtual machines owned by this documentation command.
 String getWordIndexField()
          Index field for MS-Word documentation.
 String getWordTemplate()
          Template file name for generation in MS-Word format.
 String getWordTOCField()
          Table of contents field for MS-Word documentation.
 String getWordTOFField()
          Table of figures field for MS-Word documentation.
 String getWordTOTField()
          Table of tables field for MS-Word documentation.
 String getXSLStyleSheet()
          Stylesheet for the stylesheet processor.
 String getXSLStyleSheetProcessor()
          Command string for the stylesheet processor.
 boolean isReport()
          Is report documentation.
 void setChangeChapterHeadings(K_DOCU_CHANGE_CHAPTER_MODE value)
          Set the value of Attribut ChangeChapterHeadings.
 void setDGSelection(DGSelection value)
          Set the value of Foreign Key DGSelection.
 void setLeastCommonPackage(boolean value)
          Set the value of Attribut LeastCommonPackage.
 void setNoMultiPageGraphics(boolean value)
          Set the value of Attribut NoMultiPageGraphics.
 void setOpenMode(K_DOCU_OPEN_MODE value)
          Set the value of Attribut OpenMode.
 void setPerformInputCheck(boolean value)
          Set the value of Attribut PerformInputCheck.
 void setPostprocessingArguments(String value)
          Set the value of Attribut PostprocessingArguments.
 void setPostprocessingCommand(String value)
          Set the value of Attribut PostprocessingCommand.
 void setProfile(MMProfile value)
          Set the value of Foreign Key Profile.
 void setRemoveEmptyChapters(boolean value)
          Set the value of Attribut RemoveEmptyChapters.
 void setReportCommand(String value)
          Set the value of Attribut ReportCommand.
 void setWordIndexField(String value)
          Set the value of Attribut WordIndexField.
 void setWordTemplate(String value)
          Set the value of Attribut WordTemplate.
 void setWordTOCField(String value)
          Set the value of Attribut WordTOCField.
 void setWordTOFField(String value)
          Set the value of Attribut WordTOFField.
 void setWordTOTField(String value)
          Set the value of Attribut WordTOTField.
 void setXSLStyleSheetProcessor(String value)
          Set the value of Attribut XSLStyleSheetProcessor.
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble
getUUID, setUUID
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMMenuItemAble
getMenuItem
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELPresOptAble
getBitmap, getColor, getOwnedPresOpt
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLocalizAble
getOwnedLocaleName, hasAnyLocalizedName, hasLocalizedName
 
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.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMMetaCommentAble
getDescription
 
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.ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner
 
Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLocalizedPropertyAble
getOwnedLocalizedProperty
 
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.ADExecuteAble
getRoleExecution, hasExecution
 

Method Detail

executeDocu

ARG_DocuOut executeDocu(List<? extends ELElement> seq)
                        throws InoNetException,
                               SrvErrorException
Execute a Documentation Command on the server.

Parameters:
seq - List of ELElement
Throws:
InoNetException
SrvErrorException

getChangeChapterHeadings

K_DOCU_CHANGE_CHAPTER_MODE getChangeChapterHeadings()
                                                    throws InoNetException,
                                                           SrvErrorException
Specifies which chapter headings are converted to dash lists.

Throws:
InoNetException
SrvErrorException

getCheckInput

boolean getCheckInput(List<? extends ELElement> seq)
                      throws InoNetException,
                             SrvErrorException
Checks wether this documentation command can produces output with the current selection.

Parameters:
seq - List of ELElement
Throws:
InoNetException
SrvErrorException

getClassPathValue

List<ELValSpecString> getClassPathValue(K_CONTROL_OPTION... behaviourFlags)
                                        throws InoNetException,
                                               SrvErrorException
All string values of class paths owned by this documentation command.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted.

getDGSelection

DGSelection getDGSelection()
                           throws InoNetException,
                                  SrvErrorException
The documentation selection that owns this docu command.

Throws:
InoNetException
SrvErrorException

getGraphicFormat

K_DOCU_GRAPHIC_FORMAT getGraphicFormat()
                                       throws InoNetException,
                                              SrvErrorException
Format of graphics.

Throws:
InoNetException
SrvErrorException

getLeastCommonPackage

boolean getLeastCommonPackage()
                              throws InoNetException,
                                     SrvErrorException
Use least common package as root of documentation.

Throws:
InoNetException
SrvErrorException

getNoMultiPageGraphics

boolean getNoMultiPageGraphics()
                               throws InoNetException,
                                      SrvErrorException
Collate multi-paged graphics.

Throws:
InoNetException
SrvErrorException

getOpenMode

K_DOCU_OPEN_MODE getOpenMode()
                             throws InoNetException,
                                    SrvErrorException
Specifies if the generated documentation is opened.

Throws:
InoNetException
SrvErrorException

getOutputDirectory

String getOutputDirectory()
                          throws InoNetException,
                                 SrvErrorException
Directory path for generated files.

Throws:
InoNetException
SrvErrorException

getOutputKind

K_DOCU_TYPE getOutputKind()
                          throws InoNetException,
                                 SrvErrorException
Kind of output.

Throws:
InoNetException
SrvErrorException

getOutputRepositories

String getOutputRepositories()
                             throws InoNetException,
                                    SrvErrorException
Name used for repository files.

Throws:
InoNetException
SrvErrorException

getPerformInputCheck

boolean getPerformInputCheck()
                             throws InoNetException,
                                    SrvErrorException
Perform an input check before documentation generation.

Throws:
InoNetException
SrvErrorException

getPostprocessingArguments

String getPostprocessingArguments()
                                  throws InoNetException,
                                         SrvErrorException
The arguments of the postprocessing command.

Throws:
InoNetException
SrvErrorException

getPostprocessingCommand

String getPostprocessingCommand()
                                throws InoNetException,
                                       SrvErrorException
The postprocessing command of this documentation command.

Throws:
InoNetException
SrvErrorException

getPrinterName

String getPrinterName()
                      throws InoNetException,
                             SrvErrorException
The printer to be used.

Throws:
InoNetException
SrvErrorException

getProfile

MMProfile getProfile()
                     throws InoNetException,
                            SrvErrorException
The profile that owns this docu command.

Throws:
InoNetException
SrvErrorException

getRemoveEmptyChapters

boolean getRemoveEmptyChapters()
                               throws InoNetException,
                                      SrvErrorException
Remove empty chapters.

Throws:
InoNetException
SrvErrorException

getReportCommand

String getReportCommand()
                        throws InoNetException,
                               SrvErrorException
The java command called if the postprocessing command is inojava.

Throws:
InoNetException
SrvErrorException

getSearchName

String getSearchName()
                     throws InoNetException,
                            SrvErrorException
Search, which is executed before documentation generation, in order to determine the selection.

Throws:
InoNetException
SrvErrorException

getSearchPath

String getSearchPath()
                     throws InoNetException,
                            SrvErrorException
Search path for include and imports.

Throws:
InoNetException
SrvErrorException

getVirtualMachineValue

List<ELValSpecString> getVirtualMachineValue(K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
                                                    SrvErrorException
All string values of virtual machines owned by this documentation command.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException
Sorted:
the result may be sorted.

getWordIndexField

String getWordIndexField()
                         throws InoNetException,
                                SrvErrorException
Index field for MS-Word documentation.

Throws:
InoNetException
SrvErrorException

getWordTemplate

String getWordTemplate()
                       throws InoNetException,
                              SrvErrorException
Template file name for generation in MS-Word format.

Throws:
InoNetException
SrvErrorException

getWordTOCField

String getWordTOCField()
                       throws InoNetException,
                              SrvErrorException
Table of contents field for MS-Word documentation.

Throws:
InoNetException
SrvErrorException

getWordTOFField

String getWordTOFField()
                       throws InoNetException,
                              SrvErrorException
Table of figures field for MS-Word documentation.

Throws:
InoNetException
SrvErrorException

getWordTOTField

String getWordTOTField()
                       throws InoNetException,
                              SrvErrorException
Table of tables field for MS-Word documentation.

Throws:
InoNetException
SrvErrorException

getXSLStyleSheet

String getXSLStyleSheet()
                        throws InoNetException,
                               SrvErrorException
Stylesheet for the stylesheet processor.

Throws:
InoNetException
SrvErrorException

getXSLStyleSheetProcessor

String getXSLStyleSheetProcessor()
                                 throws InoNetException,
                                        SrvErrorException
Command string for the stylesheet processor.

Throws:
InoNetException
SrvErrorException

isReport

boolean isReport()
                 throws InoNetException,
                        SrvErrorException
Is report documentation.

Throws:
InoNetException
SrvErrorException

setChangeChapterHeadings

void setChangeChapterHeadings(K_DOCU_CHANGE_CHAPTER_MODE value)
                              throws InoNetException,
                                     SrvErrorException
Set the value of Attribut ChangeChapterHeadings.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setDGSelection

void setDGSelection(DGSelection value)
                    throws InoNetException,
                           SrvErrorException
Set the value of Foreign Key DGSelection.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setLeastCommonPackage

void setLeastCommonPackage(boolean value)
                           throws InoNetException,
                                  SrvErrorException
Set the value of Attribut LeastCommonPackage.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setNoMultiPageGraphics

void setNoMultiPageGraphics(boolean value)
                            throws InoNetException,
                                   SrvErrorException
Set the value of Attribut NoMultiPageGraphics.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setOpenMode

void setOpenMode(K_DOCU_OPEN_MODE value)
                 throws InoNetException,
                        SrvErrorException
Set the value of Attribut OpenMode.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setPerformInputCheck

void setPerformInputCheck(boolean value)
                          throws InoNetException,
                                 SrvErrorException
Set the value of Attribut PerformInputCheck.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setPostprocessingArguments

void setPostprocessingArguments(String value)
                                throws InoNetException,
                                       SrvErrorException
Set the value of Attribut PostprocessingArguments.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setPostprocessingCommand

void setPostprocessingCommand(String value)
                              throws InoNetException,
                                     SrvErrorException
Set the value of Attribut PostprocessingCommand.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setProfile

void setProfile(MMProfile value)
                throws InoNetException,
                       SrvErrorException
Set the value of Foreign Key Profile.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setRemoveEmptyChapters

void setRemoveEmptyChapters(boolean value)
                            throws InoNetException,
                                   SrvErrorException
Set the value of Attribut RemoveEmptyChapters.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setReportCommand

void setReportCommand(String value)
                      throws InoNetException,
                             SrvErrorException
Set the value of Attribut ReportCommand.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setWordIndexField

void setWordIndexField(String value)
                       throws InoNetException,
                              SrvErrorException
Set the value of Attribut WordIndexField.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setWordTemplate

void setWordTemplate(String value)
                     throws InoNetException,
                            SrvErrorException
Set the value of Attribut WordTemplate.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setWordTOCField

void setWordTOCField(String value)
                     throws InoNetException,
                            SrvErrorException
Set the value of Attribut WordTOCField.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setWordTOFField

void setWordTOFField(String value)
                     throws InoNetException,
                            SrvErrorException
Set the value of Attribut WordTOFField.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setWordTOTField

void setWordTOTField(String value)
                     throws InoNetException,
                            SrvErrorException
Set the value of Attribut WordTOTField.

Parameters:
value - The value to be set.
Throws:
InoNetException
SrvErrorException

setXSLStyleSheetProcessor

void setXSLStyleSheetProcessor(String value)
                               throws InoNetException,
                                      SrvErrorException
Set the value of Attribut XSLStyleSheetProcessor.

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.