This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class %DeepSee.Report.UI.NewReportWizard extends %ZEN.Dialog.standardDialog

Standard template for New Report within the DeepSee Report GUI. This dialog validates the classname for both lexical correctness as well as availability. If acceptable, the dialog returns its value in a JavaScript object. This takes the form of:
value.pkgName : The package name
value.clsName : The Cache class name
value.appName : The Zen application associated with this report (if any)
value.rptName : The semantic name of the report
value.desc : The description detail of the report (if any)

Property Inventory

Method Inventory


parameter DOMAIN = %DeepSee;
Inherited description: Localization domain
parameter FAVORITEICON = portal/deepsee.ico;
DeepSee favorite icon.
parameter JSINCLUDES = zenCSLM.js;
Inherited description: Comma-separated list of additional JS include files for the page.


property checkUsers as %ZEN.Datatype.boolean (ZENURL = "CHECKUSERS") [ InitialExpression = 1 ];
Optional flag to indicate that interclass dependencies should be checked before offering the user to option to reuse(with destructive overwrite) a given filename
Property methods: checkUsersDisplayToLogical(), checkUsersGet(), checkUsersIsValid(), checkUsersLogicalToDisplay(), checkUsersLogicalToOdbc(), checkUsersLogicalToXSD(), checkUsersNormalize(), checkUsersSet(), checkUsersXSDToLogical()
property skipApp as %Boolean (ZENURL = "NOAPP") [ InitialExpression = 0 ];
Property methods: skipAppDisplayToLogical(), skipAppGet(), skipAppIsValid(), skipAppLogicalToDisplay(), skipAppLogicalToXSD(), skipAppNormalize(), skipAppSet(), skipAppXSDToLogical()
property super as %ZEN.Datatype.string (ZENURL = "SUPER");
Optional name of the superclass of files created by the editor who asked for this dialog in the first place
Property methods: superDisplayToLogical(), superGet(), superIsValid(), superLogicalToDisplay(), superLogicalToOdbc(), superNormalize(), superSet()


method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
method CreateApplicationRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the Application dataCombo.
method CreatePackageRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the Package dataCombo.
classmethod ExtractClassNames(ByRef pMetaData, ByRef pData) as %String
Given an array of the form returned by %GetClassListArray of %ZEN.FinderUtils, reduce it down to a CSV string of just class names
classmethod GetDSVRDependencies(pCls As %String) as %ZEN.Datatype.string [ ZenMethod ]
Given the name of an abstract DSVR presentation class, return a CSV list of all of its children and the data collectors they rely upon. Each record in the list is of the form PresenterClassName|CollectorClassName. Note that CVS strings are used rather than native COS data structures to simplify data exchanges with client- side JavaScript
classmethod IsDSVRClass(pCls As %String, pParentCls As %String, pCheckUsers As %Boolean) as %ZEN.Datatype.string [ ZenMethod ]
Test to see if the given class is a product of one of DSVR's own editors
classmethod IsUsedBy(pCls As %String) as %ZEN.Datatype.string [ ZenMethod ]
Given the name of a data collector or data schema interface DSVR class Return a CSV list of all the presentation classes that make use of it. Note that CVS strings are used rather than native COS data structures to simplify data exchanges with clientside JavaScript
classmethod IsValidClassName(pCls As %String) as %String [ ZenMethod ]
Validate that the given class name is valid.
Returns an error message if invalid.
classmethod ValidateParentClass(pCls) as %ZEN.Datatype.boolean [ ZenMethod ]
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.
Check ClassName value.
clientmethod ondialogStart() [ Language = javascript ]
This is called when the dialog is first displayed; This provides a chance to set focus etc.
clientmethod updateState() [ Language = javascript ]
clientmethod validateClassName() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods