Home > Class Reference > %SYS namespace > %CSP.UI.Portal.Dialog.SQLView

%CSP.UI.Portal.Dialog.SQLView

class %CSP.UI.Portal.Dialog.SQLView 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.

Edit SQL View for Management Portal

Property Inventory

Method Inventory

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.SQLView.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 = SQLViewEdit;
Displayed name of this page.
parameter RESOURCE = %Development;
Security requirement

Properties

property BuilderPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/%25CSP.UI.SQL.QueryBuilderWindow.cls",,1) ];
Property methods: BuilderPageDisplayToLogical(), BuilderPageGet(), BuilderPageIsValid(), BuilderPageLogicalToDisplay(), BuilderPageLogicalToOdbc(), BuilderPageNormalize(), BuilderPageSet()
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()
property VIEWNAME as %ZEN.Datatype.string (ZENURL = "VIEWNAME");
When editing, this is passed in.
Property methods: VIEWNAMEDisplayToLogical(), VIEWNAMEGet(), VIEWNAMEIsValid(), VIEWNAMELogicalToDisplay(), VIEWNAMELogicalToOdbc(), VIEWNAMENormalize(), VIEWNAMESet()
property isNew as %ZEN.Datatype.string (ZENURL = "isNew");
Indicate whether this is to create or edit view.
Property methods: isNewDisplayToLogical(), isNewGet(), isNewIsValid(), isNewLogicalToDisplay(), isNewLogicalToOdbc(), isNewNormalize(), isNewSet()

Methods

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 ]
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.
classmethod SaveData(isNew, Schema, ViewName, ViewText, CheckOption, GrantPublic) as %String [ Language = objectscript, ZenMethod ]
VIEWNAME, Schema, ViewName, ViewText, CheckOption, ReadOnly
clientmethod doQueryBuilder() [ Language = javascript ]
clientmethod doSave() [ Language = javascript ]
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 ]
Inherited description: This client event, if present, is fired when a popup page has specified this component as its parent and fires an action.
popupName is the name of the popup window sending the action.
action is the name of the action.
value is the value associated with the action.
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 showNewSchema() [ Language = javascript ]
clientmethod validate() [ Language = javascript ]
If creating a new view, make sure that the view name is not empty.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window