Home > Class Reference > %SYS namespace > %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.ModuleWizard

%ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.ModuleWizard

class %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.ModuleWizard extends %ZHSLIB.PackageManager.Developer.Extension.UI.templatePage

This page allows user to create or edit a module for Package Management

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter CSSINCLUDES = bootstrap-3-3-5/dist/css/bootstrap.min.css,bootstrap-table/bootstrap-table.css,bootstrap-table/bootstrap-editable.css;
Inherited description: Comma-separated list of additional CSS include files for the page. If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).
parameter HELPID = GHSPM_module_wizard;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter TEMPLATEDESCRIPTION = Create or Edit a Module;
Inherited description: Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATEGROUP = General;
Inherited description: If this is a TEMPLATEMODE="new" then this is the name of the tab in Studio this template is dispayed on. If none specified then it displays on 'Custom' tab.
parameter TEMPLATEMODE = new;
What type of template.
parameter TEMPLATENAME = Module Wizard;
Inherited description: Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = Package Manager - Module Wizard;
Inherited description: Title of the template to show in the template window.
parameter TEMPLATETYPE = XML;
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 (Including Private)

property InternalName as %ZEN.Datatype.string (ZENURL = "InternalName");
Property methods: InternalNameDisplayToLogical(), InternalNameGet(), InternalNameIsValid(), InternalNameLogicalToDisplay(), InternalNameLogicalToOdbc(), InternalNameNormalize(), InternalNameSet()
property WizardTitle as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Module Wizard") ];
Property methods: WizardTitleDisplayToLogical(), WizardTitleGet(), WizardTitleIsValid(), WizardTitleLogicalToDisplay(), WizardTitleLogicalToOdbc(), WizardTitleNormalize(), WizardTitleSet()

Methods (Including Private)

method %GetDescHTML(pSeed As %String) as %Status [ Language = objectscript ]
Provide contents of description component.
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.
private method %OnGetJSResources(ByRef pResources As %String) as %Status [ Language = objectscript ]
Pages can implement this callback method in order to define a set of client-side resources: javascript strings that have been localized.
This method should fill in the array pResources with a set of localized strings, indexed by resource id:
   Set pResources("MyId") = $$$Text("Some string")
  
Javascript methods can refer to these resources using the helper function zenGetResource:
 alert(zenText('MyId'));
Zen defines a set of built-in resource strings using this mechanism. These have a "zen" prefix to keep them seperate from user ids.
You can also override the same callback method within your %ZEN.application class if you wish to share resources across an application. In this case, the application-wide callback is invoked first.
method %OnGetSubtitle() as %String [ Language = objectscript ]
Get the (localized) subtitle string for the page. This may be implemented in a subclass.
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. This is implemented by subclasses.
method GetDependencySQL(ByRef pParams As %String, ByRef pSQL As %String, pCriteria As %ZEN.proxyObject, ByRef pPagingInfo As %String) as %Status [ Language = objectscript ]
method GetInstallerClassListSQL(ByRef pParams As %String, ByRef pSQL As %String, pCriteria As %ZEN.proxyObject, ByRef pPagingInfo As %String) as %Status [ Language = objectscript ]
method GetLifecycleClassListSQL(ByRef pParams As %String, ByRef pSQL As %String, pCriteria As %ZEN.proxyObject, ByRef pPagingInfo As %String) as %Status [ Language = objectscript ]
method GetModuleDefinition(ByRef pParams, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
classmethod GetModuleNameList() as %String [ Language = objectscript, ZenMethod ]
Unused
method GetPackagingListSQL(ByRef pParams As %String, ByRef pSQL As %String, pCriteria As %ZEN.proxyObject, ByRef pPagingInfo As %String) as %Status [ Language = objectscript ]
method GetProcessorClassAttributes(ByRef pParams, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
method GetProcessorClassSQL(ByRef pParams As %String, ByRef pSQL As %String, pCriteria As %ZEN.proxyObject, ByRef pPagingInfo As %String) as %Status [ Language = objectscript ]
method GetResourceAttributeSQL(ByRef pParams As %String, ByRef pSQL As %String, pCriteria As %ZEN.proxyObject, ByRef pPagingInfo As %String) as %Status [ Language = objectscript ]
method GetResourceSQL(ByRef pParams As %String, ByRef pSQL As %String, pCriteria As %ZEN.proxyObject, ByRef pPagingInfo As %String) as %Status [ Language = objectscript ]
classmethod Submit(pInternalName As %String, pJSONString As %String) as %Boolean [ Language = objectscript, ZenMethod ]
classmethod ValidateVersion(pVersion As %String, pType) as %String [ Language = objectscript, ZenMethod ]
Validate version string. Return 1 (success) or 0 (failure) or unexpected error message
clientmethod addDependency() [ Language = javascript ]
clientmethod addResource() [ Language = javascript ]
clientmethod canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
clientmethod canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
clientmethod generateReferenceDropDown(control) [ Language = javascript ]
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 loadBootstrapTable(tableCtrl) [ Language = javascript ]
This method is used for loading both the Dependencies table and the Resources table. The control id for each table should be passed in.
clientmethod loadLocalizedStrings() [ Language = javascript ]
clientmethod loadModule() [ Language = javascript ]
clientmethod loadModuleDropdown() [ Language = javascript ]
clientmethod loadProcessorAttributes(processorClass, processorClassAttributes) [ Language = javascript ]
clientmethod loadVersionDropdown(moduleName) [ Language = javascript ]
The Version dropdown list is cleared and repopulated when user selected a module name or when edit dependency is selected from the dependency table.
clientmethod nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
clientmethod onfinishHandler() [ Language = javascript ]
Inherited description: This is called when the template is finished;
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod previousPage() [ Language = javascript ]
Go to the previous page of the template (if there is one).
clientmethod replaceEntity(string) [ Language = javascript ]
clientmethod saveEdit() [ Language = javascript ]
Save modal dialog edit
clientmethod setTableCell(tableId, rowId, colNum, newValue) [ Language = javascript ]
Generic utility to update a specific table cell
clientmethod tableEvent(tableName, data, index) [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)