%CSP.UI.Portal.Dialog.RemoteDatabase

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

New Remote Database Dialog 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 AUTONS = 0;
Inherited description: If $NAMESPACE is set, auto switch namespace
parameter CSPURL = /csp/sys/mgr/%CSP.UI.Portal.Dialog.RemoteDatabase.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 EMSSERVICE = Namespace;
parameter HELPID = GSA_config_databases_remote;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter PAGENAME = RemoteDatabase;
Displayed name of this page.
parameter RESOURCE = %Admin_Manage;
User must hold at least operator privilege to use this dialog.

Properties

property MsgDisabled as %String [ InitialExpression = $$$Text("The selected server connection is disabled.") ];
Property methods: MsgDisabledDisplayToLogical(), MsgDisabledGet(), MsgDisabledIsValid(), MsgDisabledLogicalToDisplay(), MsgDisabledLogicalToOdbc(), MsgDisabledNormalize(), MsgDisabledSet()
property MsgNotConnected as %String [ InitialExpression = $$$Text("The selected server cannot be reached.") ];
Property methods: MsgNotConnectedDisplayToLogical(), MsgNotConnectedGet(), MsgNotConnectedIsValid(), MsgNotConnectedLogicalToDisplay(), MsgNotConnectedLogicalToOdbc(), MsgNotConnectedNormalize(), MsgNotConnectedSet()
property PID as %String (ZENURL = "PID");
Database for edit. Null if adding new database.
Property methods: PIDDisplayToLogical(), PIDGet(), PIDIsValid(), PIDLogicalToDisplay(), PIDLogicalToOdbc(), PIDNormalize(), PIDSet()
property SelectedServer as %String;
Property methods: SelectedServerDisplayToLogical(), SelectedServerGet(), SelectedServerIsValid(), SelectedServerLogicalToDisplay(), SelectedServerLogicalToOdbc(), SelectedServerNormalize(), SelectedServerNotNormalDisplayToLogical(), SelectedServerNotNormalGet(), SelectedServerNotNormalIsValid(), SelectedServerNotNormalLogicalToDisplay(), SelectedServerNotNormalLogicalToXSD(), SelectedServerNotNormalNormalize(), SelectedServerNotNormalSet(), SelectedServerNotNormalXSDToLogical(), SelectedServerSet()
property SelectedServerNotNormal as %Boolean [ InitialExpression = 0 ];
Property methods: SelectedServerNotNormalDisplayToLogical(), SelectedServerNotNormalGet(), SelectedServerNotNormalIsValid(), SelectedServerNotNormalLogicalToDisplay(), SelectedServerNotNormalLogicalToXSD(), SelectedServerNotNormalNormalize(), SelectedServerNotNormalSet(), SelectedServerNotNormalXSDToLogical()

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 CheckDBName(Name As %String) as %Boolean [ Language = objectscript, ZenMethod ]
Return 1 if the database name is OK
classmethod SaveData(PID As %String, pProxy As %ZEN.proxyObject) as %String [ Language = objectscript, ZenMethod ]
Call server save method. Subclass may override.
clientmethod changeDirectory(dataCombo) [ Language = javascript ]
clientmethod changeSelectList(radioSet) [ Language = javascript ]
clientmethod changeServer(dataCombo) [ Language = javascript ]
clientmethod disableDatabaseSelect(flag) [ 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 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 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 set focus etc.
clientmethod showServerWarning(flag) [ Language = javascript ]
clientmethod validate() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback