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?

%CSP.UI.Template.List

abstract class %CSP.UI.Template.List extends %CSP.UI.Portal.Utils

This class is used internally by Caché. 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.

This is the template for SMP pages with a Search pane on the left and Result pane on the right. It is primarily used by the System Explorer's Classes/Routines/Globals list pages.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter PAGENAME = Template List;
Displayed name of this page.

Properties

property BeginDate as %String;
Property methods: BeginDateDisplayToLogical(), BeginDateGet(), BeginDateIsValid(), BeginDateLogicalToDisplay(), BeginDateLogicalToOdbc(), BeginDateNormalize(), BeginDateSet()
property ClassURL as %String;
Property methods: ClassURLDisplayToLogical(), ClassURLGet(), ClassURLIsValid(), ClassURLLogicalToDisplay(), ClassURLLogicalToOdbc(), ClassURLNormalize(), ClassURLSet()
property DocPage as %String;
Property methods: DocPageDisplayToLogical(), DocPageGet(), DocPageIsValid(), DocPageLogicalToDisplay(), DocPageLogicalToOdbc(), DocPageNormalize(), DocPageSet()
property EndDate as %String;
Property methods: EndDateDisplayToLogical(), EndDateGet(), EndDateIsValid(), EndDateLogicalToDisplay(), EndDateLogicalToOdbc(), EndDateNormalize(), EndDateSet()
property GlobalURL as %String;
Property methods: GlobalURLDisplayToLogical(), GlobalURLGet(), GlobalURLIsValid(), GlobalURLLogicalToDisplay(), GlobalURLLogicalToOdbc(), GlobalURLNormalize(), GlobalURLSet()
property MaxRows as %String;
Property methods: MaxRowsDisplayToLogical(), MaxRowsGet(), MaxRowsIsValid(), MaxRowsLogicalToDisplay(), MaxRowsLogicalToOdbc(), MaxRowsNormalize(), MaxRowsSet()
property NamespaceList as %String;
Property methods: NamespaceListDisplayToLogical(), NamespaceListGet(), NamespaceListIsValid(), NamespaceListLogicalToDisplay(), NamespaceListLogicalToOdbc(), NamespaceListNormalize(), NamespaceListSet()
property RoutineURL as %String;
Property methods: RoutineURLDisplayToLogical(), RoutineURLGet(), RoutineURLIsValid(), RoutineURLLogicalToDisplay(), RoutineURLLogicalToOdbc(), RoutineURLNormalize(), RoutineURLSet()
property ShowGen as %Boolean [ InitialExpression = "0" ];
Property methods: ShowGenDisplayToLogical(), ShowGenGet(), ShowGenIsValid(), ShowGenLogicalToDisplay(), ShowGenLogicalToXSD(), ShowGenNormalize(), ShowGenSet(), ShowGenXSDToLogical()
property ShowMap as %Boolean [ InitialExpression = "1" ];
Property methods: ShowMapDisplayToLogical(), ShowMapGet(), ShowMapIsValid(), ShowMapLogicalToDisplay(), ShowMapLogicalToXSD(), ShowMapNormalize(), ShowMapSet(), ShowMapXSDToLogical()
property ShowSys as %Boolean [ InitialExpression = "0" ];
Property methods: ShowSysDisplayToLogical(), ShowSysGet(), ShowSysIsValid(), ShowSysLogicalToDisplay(), ShowSysLogicalToXSD(), ShowSysNormalize(), ShowSysSet(), ShowSysXSDToLogical()

Methods

classmethod %ChangeNS(pNS As %String) as %Status
Proposed change to override %ChangeNS in %ZEN.Controller For SMP Explorer, we need to override the behavior of changing Namespace so that the error reporting is more appropriate.
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnAfterCreatePage() as %Status
Subclass to override. Always include code in this method.
classmethod FindDBDir(DBName) as %String [ ZenMethod ]
Given a DBName, return the DBDirectory. If we cannot find it, then return the first one we can find.
classmethod FindDBName(DBDirectory) as %String [ ZenMethod ]
Given a DBDirectory, return the DBName
classmethod GetDBList() as %String [ ZenMethod ]
Return Database list for UI's displayList. valueList (should not be loaded into