Package com.altova.automation.XMLSpy

Class WSDLDocumentationDlg

java.lang.Object

com.altova.automation.libs.COMIUnknownObject

com.altova.automation.libs.COMIDispatchObject

com.altova.automation.XMLSpy.WSDLDocumentationDlg

public class WSDLDocumentationDlg
extends COMIDispatchObject

Field Summary

Fields inherited from class com.altova.automation.libs.COMIDispatchObject

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Method Summary

Modifier and Type	Method	Description
void	allDetails(boolean bDetailsOn)	Switches all Details on or off.
COMIDispatchObject	getApplication()	Returns the Application object.
boolean	getCreateDiagramsFolder()	Returnssets a value indicating whether to create a separate folder for diagrams or not.
Enums.SPYImageKind	getDiagramFormat()	Returnssets the image kind that is generated.
boolean	getEmbedCSSInHTML()	Returnssets a value indicating whether to embed the CSS in the HTML or not.
boolean	getEmbedDiagrams()	Returnssets a value indicating whether to embed the diagrams in the document or not.
boolean	getGlobalElementsAndTypesOnly()	Returnssets a value indicating whether a full Schema documentation is done or only Global Elements and Types are documented.
boolean	getIncludeBinding()	Returnssets a value indicating whether bindings are included.
boolean	getIncludeImportedWSDLFiles()	Returnssets a value indicating whether imported WSDL files are included.
boolean	getIncludeMessages()	Returnssets a value indicating whether messages are included.
boolean	getIncludeOverview()	Returnssets a value indicating whether an overview is included.
boolean	getIncludePortType()	Returnssets a value indicating whether port types are included.
boolean	getIncludeService()	Returnssets a value indicating whether services are included.
boolean	getIncludeTypes()	Returnssets a value indicating whether types are included.
GUID	getInterfaceIID()
boolean	getMultipleOutputFiles()	Returnssets a value indicating whether the output document is split to multiple files.
Enums.SPYDialogAction	getOptionsDialogAction()	Specifies how the options dialog is handled.
java.lang.String	getOutputFile()	Returnssets the output file.
Enums.SPYDialogAction	getOutputFileDialogAction()	Specifies how the file dialog is handled.
Enums.SPYSchemaDocumentationFormat	getOutputFormat()	Returnssets the output format.
COMIDispatchObject	getParent()	Returns the Parent object.
boolean	getSeparateSchemaDocument()	Returnssets a value indicating whether the Schema documentation should be placed in a separate document.
boolean	getShowBindingDiagram()	Returnssets a value indicating whether binding diagrams are shown.
boolean	getShowExtensibility()	Returnssets a value indicating whether extensibilities are shown.
boolean	getShowMessageParts()	Returnssets a value indicating whether message parts are shown.
boolean	getShowPort()	Returnssets a value indicating whether ports are shown.
boolean	getShowPortTypeDiagram()	Returnssets a value indicating whether port type diagrams are shown.
boolean	getShowPortTypeOperations()	Returnssets a value indicating whether port type operations are shown.
boolean	getShowProgressBar()	Returnssets a value indicating whether a progress bar is displayed during the generation.
boolean	getShowResult()	Returnssets a value indicating whether the document is shown after the generation.
boolean	getShowServiceDiagram()	Returnssets a value indicating whether service diagrams are shown.
boolean	getShowSourceCode()	Returnssets a value indicating whether source code is shown.
boolean	getShowTypesDiagram()	Returnssets a value indicating whether type diagrams are shown.
boolean	getShowUsedBy()	Returnssets a value indicating whether 'used by' is shown.
java.lang.String	getSPSFile()	Returnssets a value indicating the location of the SPS file.
boolean	getUseFixedDesign()	Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.
void	includeAll(boolean bInclude)	Switches all Includes on or off.
void	setCreateDiagramsFolder(boolean newValue)	Returnssets a value indicating whether to create a separate folder for diagrams or not.
void	setDiagramFormat(Enums.SPYImageKind newValue)	Returnssets the image kind that is generated.
void	setEmbedCSSInHTML(boolean newValue)	Returnssets a value indicating whether to embed the CSS in the HTML or not.
void	setEmbedDiagrams(boolean newValue)	Returnssets a value indicating whether to embed the diagrams in the document or not.
void	setGlobalElementsAndTypesOnly(boolean newValue)	Returnssets a value indicating whether a full Schema documentation is done or only Global Elements and Types are documented.
void	setIncludeBinding(boolean newValue)	Returnssets a value indicating whether bindings are included.
void	setIncludeImportedWSDLFiles(boolean newValue)	Returnssets a value indicating whether imported WSDL files are included.
void	setIncludeMessages(boolean newValue)	Returnssets a value indicating whether messages are included.
void	setIncludeOverview(boolean newValue)	Returnssets a value indicating whether an overview is included.
void	setIncludePortType(boolean newValue)	Returnssets a value indicating whether port types are included.
void	setIncludeService(boolean newValue)	Returnssets a value indicating whether services are included.
void	setIncludeTypes(boolean newValue)	Returnssets a value indicating whether types are included.
void	setMultipleOutputFiles(boolean newValue)	Returnssets a value indicating whether the output document is split to multiple files.
void	setOptionsDialogAction(Enums.SPYDialogAction newValue)	Specifies how the options dialog is handled.
void	setOutputFile(java.lang.String newValue)	Returnssets the output file.
void	setOutputFileDialogAction(Enums.SPYDialogAction newValue)	Specifies how the file dialog is handled.
void	setOutputFormat(Enums.SPYSchemaDocumentationFormat newValue)	Returnssets the output format.
void	setSeparateSchemaDocument(boolean newValue)	Returnssets a value indicating whether the Schema documentation should be placed in a separate document.
void	setShowBindingDiagram(boolean newValue)	Returnssets a value indicating whether binding diagrams are shown.
void	setShowExtensibility(boolean newValue)	Returnssets a value indicating whether extensibilities are shown.
void	setShowMessageParts(boolean newValue)	Returnssets a value indicating whether message parts are shown.
void	setShowPort(boolean newValue)	Returnssets a value indicating whether ports are shown.
void	setShowPortTypeDiagram(boolean newValue)	Returnssets a value indicating whether port type diagrams are shown.
void	setShowPortTypeOperations(boolean newValue)	Returnssets a value indicating whether port type operations are shown.
void	setShowProgressBar(boolean newValue)	Returnssets a value indicating whether a progress bar is displayed during the generation.
void	setShowResult(boolean newValue)	Returnssets a value indicating whether the document is shown after the generation.
void	setShowServiceDiagram(boolean newValue)	Returnssets a value indicating whether service diagrams are shown.
void	setShowSourceCode(boolean newValue)	Returnssets a value indicating whether source code is shown.
void	setShowTypesDiagram(boolean newValue)	Returnssets a value indicating whether type diagrams are shown.
void	setShowUsedBy(boolean newValue)	Returnssets a value indicating whether 'used by' is shown.
void	setSPSFile(java.lang.String newValue)	Returnssets a value indicating the location of the SPS file.
void	setUseFixedDesign(boolean newValue)	Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.

Methods inherited from class com.altova.automation.libs.COMIDispatchObject

addListener, getProperty, getProperty, invoke, removeListener, setProperty, setProperty

Methods inherited from class com.altova.automation.libs.COMIUnknownObject

dispose, equals, getCOMInterfacePointer, isNull

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInterfaceIID

public GUID getInterfaceIID()

getApplication

public COMIDispatchObject getApplication() throws AutomationException

Returns the Application object.

Throws:

AutomationException

getParent

public COMIDispatchObject getParent() throws AutomationException

Returns the Parent object.

Throws:

AutomationException

getOptionsDialogAction

public Enums.SPYDialogAction getOptionsDialogAction() throws AutomationException

Specifies how the options dialog is handled.

Throws:

AutomationException

setOptionsDialogAction

public void setOptionsDialogAction(Enums.SPYDialogAction newValue) throws AutomationException

Specifies how the options dialog is handled.

Throws:

AutomationException

getOutputFileDialogAction

public Enums.SPYDialogAction getOutputFileDialogAction() throws AutomationException

Specifies how the file dialog is handled.

Throws:

AutomationException

setOutputFileDialogAction

public void setOutputFileDialogAction(Enums.SPYDialogAction newValue) throws AutomationException

Specifies how the file dialog is handled.

Throws:

AutomationException

getShowProgressBar

public boolean getShowProgressBar() throws AutomationException

Returnssets a value indicating whether a progress bar is displayed during the generation.

Throws:

AutomationException

setShowProgressBar

public void setShowProgressBar(boolean newValue) throws AutomationException

Returnssets a value indicating whether a progress bar is displayed during the generation.

Throws:

AutomationException

includeAll

public void includeAll(boolean bInclude) throws AutomationException

Switches all Includes on or off.

Throws:

AutomationException

allDetails

public void allDetails(boolean bDetailsOn) throws AutomationException

Switches all Details on or off.

Throws:

AutomationException

getOutputFile

public java.lang.String getOutputFile() throws AutomationException

Returnssets the output file.

Throws:

AutomationException

setOutputFile

public void setOutputFile(java.lang.String newValue) throws AutomationException

Returnssets the output file.

Throws:

AutomationException

getOutputFormat

public Enums.SPYSchemaDocumentationFormat getOutputFormat() throws AutomationException

Returnssets the output format.

Throws:

AutomationException

setOutputFormat

public void setOutputFormat(Enums.SPYSchemaDocumentationFormat newValue) throws AutomationException

Returnssets the output format.

Throws:

AutomationException

getShowResult

public boolean getShowResult() throws AutomationException

Returnssets a value indicating whether the document is shown after the generation.

Throws:

AutomationException

setShowResult

public void setShowResult(boolean newValue) throws AutomationException

Returnssets a value indicating whether the document is shown after the generation.

Throws:

AutomationException

getIncludeOverview

public boolean getIncludeOverview() throws AutomationException

Returnssets a value indicating whether an overview is included.

Throws:

AutomationException

setIncludeOverview

public void setIncludeOverview(boolean newValue) throws AutomationException

Returnssets a value indicating whether an overview is included.

Throws:

AutomationException

getIncludeService

public boolean getIncludeService() throws AutomationException

Returnssets a value indicating whether services are included.

Throws:

AutomationException

setIncludeService

public void setIncludeService(boolean newValue) throws AutomationException

Returnssets a value indicating whether services are included.

Throws:

AutomationException

getIncludeBinding

public boolean getIncludeBinding() throws AutomationException

Returnssets a value indicating whether bindings are included.

Throws:

AutomationException

setIncludeBinding

public void setIncludeBinding(boolean newValue) throws AutomationException

Returnssets a value indicating whether bindings are included.

Throws:

AutomationException

getIncludePortType

public boolean getIncludePortType() throws AutomationException

Returnssets a value indicating whether port types are included.

Throws:

AutomationException

setIncludePortType

public void setIncludePortType(boolean newValue) throws AutomationException

Returnssets a value indicating whether port types are included.

Throws:

AutomationException

getIncludeMessages

public boolean getIncludeMessages() throws AutomationException

Returnssets a value indicating whether messages are included.

Throws:

AutomationException

setIncludeMessages

public void setIncludeMessages(boolean newValue) throws AutomationException

Returnssets a value indicating whether messages are included.

Throws:

AutomationException

getIncludeTypes

public boolean getIncludeTypes() throws AutomationException

Returnssets a value indicating whether types are included.

Throws:

AutomationException

setIncludeTypes

public void setIncludeTypes(boolean newValue) throws AutomationException

Returnssets a value indicating whether types are included.

Throws:

AutomationException

getIncludeImportedWSDLFiles

public boolean getIncludeImportedWSDLFiles() throws AutomationException

Returnssets a value indicating whether imported WSDL files are included.

Throws:

AutomationException

setIncludeImportedWSDLFiles

public void setIncludeImportedWSDLFiles(boolean newValue) throws AutomationException

Returnssets a value indicating whether imported WSDL files are included.

Throws:

AutomationException

getShowServiceDiagram

public boolean getShowServiceDiagram() throws AutomationException

Returnssets a value indicating whether service diagrams are shown.

Throws:

AutomationException

setShowServiceDiagram

public void setShowServiceDiagram(boolean newValue) throws AutomationException

Returnssets a value indicating whether service diagrams are shown.

Throws:

AutomationException

getShowBindingDiagram

public boolean getShowBindingDiagram() throws AutomationException

Returnssets a value indicating whether binding diagrams are shown.

Throws:

AutomationException

setShowBindingDiagram

public void setShowBindingDiagram(boolean newValue) throws AutomationException

Returnssets a value indicating whether binding diagrams are shown.

Throws:

AutomationException

getShowPortTypeDiagram

public boolean getShowPortTypeDiagram() throws AutomationException

Returnssets a value indicating whether port type diagrams are shown.

Throws:

AutomationException

setShowPortTypeDiagram

public void setShowPortTypeDiagram(boolean newValue) throws AutomationException

Returnssets a value indicating whether port type diagrams are shown.

Throws:

AutomationException

getShowTypesDiagram

public boolean getShowTypesDiagram() throws AutomationException

Returnssets a value indicating whether type diagrams are shown.

Throws:

AutomationException

setShowTypesDiagram

public void setShowTypesDiagram(boolean newValue) throws AutomationException

Returnssets a value indicating whether type diagrams are shown.

Throws:

AutomationException

getShowMessageParts

public boolean getShowMessageParts() throws AutomationException

Returnssets a value indicating whether message parts are shown.

Throws:

AutomationException

setShowMessageParts

public void setShowMessageParts(boolean newValue) throws AutomationException

Returnssets a value indicating whether message parts are shown.

Throws:

AutomationException

getShowSourceCode

public boolean getShowSourceCode() throws AutomationException

Returnssets a value indicating whether source code is shown.

Throws:

AutomationException

setShowSourceCode

public void setShowSourceCode(boolean newValue) throws AutomationException

Returnssets a value indicating whether source code is shown.

Throws:

AutomationException

getShowExtensibility

public boolean getShowExtensibility() throws AutomationException

Returnssets a value indicating whether extensibilities are shown.

Throws:

AutomationException

setShowExtensibility

public void setShowExtensibility(boolean newValue) throws AutomationException

Returnssets a value indicating whether extensibilities are shown.

Throws:

AutomationException

getShowUsedBy

public boolean getShowUsedBy() throws AutomationException

Returnssets a value indicating whether 'used by' is shown.

Throws:

AutomationException

setShowUsedBy

public void setShowUsedBy(boolean newValue) throws AutomationException

Returnssets a value indicating whether 'used by' is shown.

Throws:

AutomationException

getShowPort

public boolean getShowPort() throws AutomationException

Returnssets a value indicating whether ports are shown.

Throws:

AutomationException

setShowPort

public void setShowPort(boolean newValue) throws AutomationException

Returnssets a value indicating whether ports are shown.

Throws:

AutomationException

getShowPortTypeOperations

public boolean getShowPortTypeOperations() throws AutomationException

Returnssets a value indicating whether port type operations are shown.

Throws:

AutomationException

setShowPortTypeOperations

public void setShowPortTypeOperations(boolean newValue) throws AutomationException

Returnssets a value indicating whether port type operations are shown.

Throws:

AutomationException

getDiagramFormat

public Enums.SPYImageKind getDiagramFormat() throws AutomationException

Returnssets the image kind that is generated.

Throws:

AutomationException

setDiagramFormat

public void setDiagramFormat(Enums.SPYImageKind newValue) throws AutomationException

Returnssets the image kind that is generated.

Throws:

AutomationException

getEmbedDiagrams

public boolean getEmbedDiagrams() throws AutomationException

Returnssets a value indicating whether to embed the diagrams in the document or not.

Throws:

AutomationException

setEmbedDiagrams

public void setEmbedDiagrams(boolean newValue) throws AutomationException

Returnssets a value indicating whether to embed the diagrams in the document or not.

Throws:

AutomationException

getMultipleOutputFiles

public boolean getMultipleOutputFiles() throws AutomationException

Returnssets a value indicating whether the output document is split to multiple files.

Throws:

AutomationException

setMultipleOutputFiles

public void setMultipleOutputFiles(boolean newValue) throws AutomationException

Returnssets a value indicating whether the output document is split to multiple files.

Throws:

AutomationException

getEmbedCSSInHTML

public boolean getEmbedCSSInHTML() throws AutomationException

Returnssets a value indicating whether to embed the CSS in the HTML or not.

Throws:

AutomationException

setEmbedCSSInHTML

public void setEmbedCSSInHTML(boolean newValue) throws AutomationException

Returnssets a value indicating whether to embed the CSS in the HTML or not.

Throws:

AutomationException

getCreateDiagramsFolder

public boolean getCreateDiagramsFolder() throws AutomationException

Returnssets a value indicating whether to create a separate folder for diagrams or not.

Throws:

AutomationException

setCreateDiagramsFolder

public void setCreateDiagramsFolder(boolean newValue) throws AutomationException

Returnssets a value indicating whether to create a separate folder for diagrams or not.

Throws:

AutomationException

getUseFixedDesign

public boolean getUseFixedDesign() throws AutomationException

Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.

Throws:

AutomationException

setUseFixedDesign

public void setUseFixedDesign(boolean newValue) throws AutomationException

Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.

Throws:

AutomationException

getSPSFile

public java.lang.String getSPSFile() throws AutomationException

Returnssets a value indicating the location of the SPS file.

Throws:

AutomationException

setSPSFile

public void setSPSFile(java.lang.String newValue) throws AutomationException

Returnssets a value indicating the location of the SPS file.

Throws:

AutomationException

getSeparateSchemaDocument

public boolean getSeparateSchemaDocument() throws AutomationException

Returnssets a value indicating whether the Schema documentation should be placed in a separate document.

Throws:

AutomationException

setSeparateSchemaDocument

public void setSeparateSchemaDocument(boolean newValue) throws AutomationException

Returnssets a value indicating whether the Schema documentation should be placed in a separate document.

Throws:

AutomationException

getGlobalElementsAndTypesOnly

public boolean getGlobalElementsAndTypesOnly() throws AutomationException

Returnssets a value indicating whether a full Schema documentation is done or only Global Elements and Types are documented.

Throws:

AutomationException

setGlobalElementsAndTypesOnly

public void setGlobalElementsAndTypesOnly(boolean newValue) throws AutomationException

Returnssets a value indicating whether a full Schema documentation is done or only Global Elements and Types are documented.

Throws:

AutomationException