%ZEN.Template.AddInWizard.SOAPWizard

class %ZEN.Template.AddInWizard.SOAPWizard extends %ZEN.Template.AddInWizard.Template

Studio Template.
The SOAP Wizard reads a WSDL (Web Services Description Language) document and creates one or more SOAP client or service classes.
Each SOAP Client class contains one or more methods that, when invoked, remotely call the corresponding Web Method of the Web Service.
Each SOAP Service class contains one or more methods that may be remotely invoked.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter HELPID = GSOAP_soapwizard;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter PAGETITLE = SOAP Wizard;
Display title of this page
parameter TEMPLATEDESCRIPTION = creates one or more SOAP client or service classes from a WSDL document.;
Inherited description: Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATENAME = SOAP Wizard;
Inherited description: Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = SOAP Wizard;
Inherited description: Title of the template to show in the template window.
parameter TEMPLATETYPE = cls;
Inherited description: Comma separated list of 'CSP', 'CSR', 'MAC', 'INT', 'INC', 'BAS', 'CLS' to say what type of code this template generates; CSP, CSR, Routine, or Class code. You can also specify '*' for all types.

Properties

property InternalPassword as %String;
Internal password to be used for HTTP authentication.
Property methods: InternalPasswordDisplayToLogical(), InternalPasswordGet(), InternalPasswordIsValid(), InternalPasswordLogicalToDisplay(), InternalPasswordLogicalToOdbc(), InternalPasswordNormalize(), InternalPasswordSet()
property InternalURL as %String;
Internally reconstructed URL with user entered username and password. This url will not be saved into recent list.
Property methods: InternalURLDisplayToLogical(), InternalURLGet(), InternalURLIsValid(), InternalURLLogicalToDisplay(), InternalURLLogicalToOdbc(), InternalURLNormalize(), InternalURLSet()
property InternalUsername as %String;
Internal username to be used for HTTP authentication.
Property methods: InternalUsernameDisplayToLogical(), InternalUsernameGet(), InternalUsernameIsValid(), InternalUsernameLogicalToDisplay(), InternalUsernameLogicalToOdbc(), InternalUsernameNormalize(), InternalUsernameSet()
property IsEnsemble as %ZEN.Datatype.boolean;
Property methods: IsEnsembleDisplayToLogical(), IsEnsembleGet(), IsEnsembleIsValid(), IsEnsembleLogicalToDisplay(), IsEnsembleLogicalToOdbc(), IsEnsembleLogicalToXSD(), IsEnsembleNormalize(), IsEnsembleSet(), IsEnsembleXSDToLogical()
property Packages as %ZEN.Datatype.string;
String that contains package names delimited by comma.
Property methods: PackagesDisplayToLogical(), PackagesGet(), PackagesIsValid(), PackagesLogicalToDisplay(), PackagesLogicalToOdbc(), PackagesNormalize(), PackagesSet()
property TotalPackages as %ZEN.Datatype.integer;
Number of total Namespaces which is the same as total packages
Property methods: TotalPackagesDisplayToLogical(), TotalPackagesGet(), TotalPackagesIsValid(), TotalPackagesLogicalToDisplay(), TotalPackagesLogicalToOdbc(), TotalPackagesNormalize(), TotalPackagesSet()
property lblFile as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Enter the path and name of a WSDL File:") ];
Property methods: lblFileDisplayToLogical(), lblFileGet(), lblFileIsValid(), lblFileLogicalToDisplay(), lblFileLogicalToOdbc(), lblFileNormalize(), lblFileSet()
property lblURL as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Enter a WSDL URL:") ];
Property methods: lblURLDisplayToLogical(), lblURLGet(), lblURLIsValid(), lblURLLogicalToDisplay(), lblURLLogicalToOdbc(), lblURLNormalize(), lblURLSet()

Methods

classmethod %DrawErrNote(pSeed) as %Status [ Language = objectscript ]
method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
classmethod %OnPreHTTP() as %Boolean [ Language = objectscript ]
Zen page notification of an HTTP request. This method can be overwritten by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.
method %OnTemplateAction() as %Status [ Language = objectscript ]
This method is called when the template is complete. Any output to the principal device is returned to the Studio.
(1) adding classes to the project; (2) classes may be opened if Studio's option "Open file to added project" is checked.
clientmethod ConfirmAddSoap() [ Language = javascript ]
this method is only called from SWT browser of Atelier
classmethod DrawNS(proxy As %ZEN.proxyObject) as %Status [ Language = objectscript ]
Draw page 3, namespaces
classmethod DrawPageTitle(pSeed As %String) as %Status [ Language = objectscript ]
classmethod FileExists(filename) as %Boolean [ Language = objectscript, ZenMethod ]
Check if file exists
classmethod GetRecentList(filetype) as %String [ Language = objectscript, ZenMethod ]
Get recent list for URLs or Files. filetype = "FILE" or "URL".
classmethod GetSRC(filetype As %String, url As %String, sslConfig As %String = "", sslCheckServerId As %Boolean, username As %String = "", password As %String = "") as %String [ Language = objectscript, ZenMethod ]
Given the url or file, load the file. Save the url or file to ^ISC.SOAPClientWizard.
classmethod GetStatus(tab) as %ZEN.proxyObject [ Language = objectscript, ZenMethod ]
tab = 3: NS - when DrawNS is finished, Status is "Done".
classmethod PreProcess(proxy As %ZEN.proxyObject) as %String [ Language = objectscript, ZenMethod ]
For page 3, do preprocess to find out whether it is multiple
classmethod SaveLast(filetype, url, sslConfig="", sslCheckServerId) [ Language = objectscript, ZenMethod ]
FileType is either "FILE" or "URL".
clientmethod canFinish() [ Language = javascript ]
Return true if this template can Finish (i.e., enable the Finish button).
clientmethod canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
This is implemented by subclasses.
clientmethod canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
clientmethod changeBusOp(ischecked) [ Language = javascript ]
User clicked "Create Business Operation". If it's checked default Class Type to Serial; Else default to Registered.
clientmethod changeClassType(ischecked) [ Language = javascript ]
User clicked class type radio button. Hide cascaded deltes check box if not persistent class type.
clientmethod changeClient(ischecked) [ Language = javascript ]
User clicked "Create Client for Web Service"
clientmethod changedFileType(thisObj) [ Language = javascript ]
User changed file type. Change label. Show filename and browse button if type is FILE.
clientmethod doBrowse() [ Language = javascript ]
Launching a file selector window.
clientmethod doLogin() [ Language = javascript ]
User typed in Username and Password. Re-construct url and try again.
clientmethod drawDone(tab) [ Language = javascript ]
This method is fired up after onDrawContent is finished. Hide progress message and display error if exists.
clientmethod getPackages() [ Language = javascript ]
Validate and return packages string. If a package name is empty, display message and return 0.
clientmethod hasMultiplePages() [ Language = javascript ]
Inherited description: Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.
clientmethod nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from file select OR qualifers dialog and setting the value into the appropriate field. The id of the field that needs to be updated is saved in "dialogClicked".
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
clientmethod onstartHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to load the last filetype, etc.
clientmethod outputDone() [ Language = javascript ]
class loading finished. Enable Finish button and hide progress message.
clientmethod previousPage() [ Language = javascript ]
Go to the previous page of the template (if there is one).
This is implemented by subclasses.
clientmethod resetMsg() [ Language = javascript ]
Inherited description: Clear message on top of page.
clientmethod retrieveSoapClasses() [ Language = javascript ]
this method is only called from SWT browser of Atelier
clientmethod showMsg(msg) [ Language = javascript ]
Inherited description: Display message on top of page.
clientmethod startMonitorFinishButton() [ Language = javascript ]
this method is only called from SWT browser of Atelier
clientmethod updateFile(file) [ Language = javascript ]
Load the recently used file into textbox
clientmethod updateURL(url) [ Language = javascript ]
Load the recently used url into textbox

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback