%CSP.UI.Portal.Dialog.SQLTuneTables

class %CSP.UI.Portal.Dialog.SQLTuneTables extends %CSP.UI.Portal.Dialog.WizardTemplate

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Tune All Tables for a Schema in a Namespace for Management Portal

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.Dialog.SQLTuneTables.zen;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter PAGENAME = SQLTuneTables;
Displayed name of this page.
parameter RESOURCE = %Development;
Security requirement

Properties (Including Private)

property BackgroundPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/%CSP.UI.SQL.QueryBuilderWindow.zen",,1) ];
Property methods: BackgroundPageDisplayToLogical(), BackgroundPageGet(), BackgroundPageIsValid(), BackgroundPageLogicalToDisplay(), BackgroundPageLogicalToOdbc(), BackgroundPageNormalize(), BackgroundPageSet()
property NAMESPACE as %ZEN.Datatype.string (ZENURL = "$NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property SCHEMA as %ZEN.Datatype.string (ZENURL = "SCHEMA");
Schema name, may or may not be available.
Property methods: SCHEMADisplayToLogical(), SCHEMAGet(), SCHEMAIsValid(), SCHEMALogicalToDisplay(), SCHEMALogicalToOdbc(), SCHEMANormalize(), SCHEMASet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
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.
method %OnGetSubtitle() as %String [ Language = objectscript ]
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod DrawPageTitle(pSeed As %String) as %Status [ Language = objectscript ]
classmethod FileExists(filename) as %Integer [ Language = objectscript, ZenMethod ]
Check to see if file exists
method ListSchemas(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean [ Language = objectscript ]
Method for executing the schemas query.
clientmethod browseSelect(name, wildcard) [ Language = javascript ]
User clicked the Browse button.
clientmethod doFinish() [ Language = javascript ]
Use clicked the Export or Export in Background button.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
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 ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
clientmethod toggleFile(bkChecked) [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window