Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [CSPX] >  [SQLQueryPane]
Private  Storage   

class CSPX.SQLQueryPane extends %CSP.Util.TablePane

(internal) This *was* a deprecated class used by early versions of Ensemble; Now it is a placeholder for a % class that exists in v5.1 of CACHELIB.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 14


Summary

Properties
Actions Align AutoRefresh CheckboxId
CommandFormClass CommandFormObject CommandSubmitPage Commands
Conditions FrameStyle HiddenColumns ItemsPerPage
MaxColumns MaxResults Name Query
SQLQuery ShowCheckboxes ShowFilter ShowLastUpdate
ShowRowNumbers ShowSearchPage ShowZebra Sortable
Styles Text URL bgcolor
border cellpadding cellspacing enableAutoRefresh

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
CreateDataSet CreateResultSet CreateTempFile DrawBODY
DrawCommandForm DrawCommands DrawHEAD DrawLastUpdate
DrawSearch DrawStatusError DrawTable ExecuteResultSet
FilterPostRS FilterTable GenerateCode GetColorByColumn
GetColumnWidths GetDescriptiveText GetItemsPerPage GetLinks
GetToolTips ItemsPerPageUpdate LocalizeColumnName LocalizeText
MakeLink OnDrawFilter OnDrawHEADTablePane OnGenerateCode
PurgeTempData QuoteCOS RefreshTable XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType wrapHTML
wrappedWidth

Subclasses
CSPX.EnsLogTablePane CSPX.EnsMsgSearchPane CSPX.EnsMsgTablePane CSPX.EnsRuleLogTablePane

Parameters

• parameter DOMAIN = "Ensemble";
Use our own domain for localization
• parameter IDCOL;
Name of ID Column if "More Data" link is to be offered ($NextID variable must be supported in CreateResultSet() also)
• parameter SHOWSQLINFO = 0;
Should this page display SQL Info
• parameter SHOWSTATISTICS = 0;
Should this page display timing stats
• parameter TOPCOUNT = 0;
Number to use in SELECT TOP, if any. Use this to affect the SQL query optimizer. Set it substantially larger than MAXROWS if FilterRS() might invalidate some of the rows returned from SQL.
• parameter XMLTYPE = "EnsSQLQueryPane";
Used to avoid the following error: ERROR #6281: XMLNAME of class CSPX.SQLQueryPane must be able to differentiate child classes of %CSP.Util.Pane.

Methods

• method DrawBODY(pInstance As %CSP.Util.PageInstance) as %Status
Draw the BODY of the detail pane
• method DrawHEAD(pInstance As %CSP.Util.PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the HEAD section.
• classmethod DrawStatusError(tSC As %String)
Generic method to draw error message for object status code.
• method ExecuteResultSet(pRS As %ResultSet, ByRef pID As %String) as %Status
This method performs the actual execution of the ResultSet This can be overridden by subclasses
• method FilterPostRS(pRS As %ResultSet, ByRef pPropVals) as %Boolean
Apply additional filter criteria to determine whether to display the current row returned by the ResultSet Return value 1 means display the current row
• method GetColorByColumn() as %String
Subclass can override this to specify the name of column used to distinctly color rows
• method GetColumnWidths(ByRef pWidthArray) as %String
Subclass can override this to specify the widths of columns used and the character(s) to wrap on (under pWidthArray(iCol,"breakchars"))
• method GetDescriptiveText()
Return (localized) text message displayed near top of page. Subclasses may override this.
• method GetLinks(ByRef pValues, ByRef pLinks)
Subclass can override this to specify hyperlinks for the columns
• method GetToolTips(ByRef pValues, ByRef pTips)
Subclass can override this to specify tooltips for the columns
• method MakeLink(pInstance As %CSP.Util.PageInstance, pHREF, ByRef pRowID, ByRef pValue) as %String
Subclass can override this to modify hyperlinks for the columns
• method OnDrawHEADTablePane(pInstance As %CSP.Util.PageInstance) as %Status
• classmethod wrapHTML(val, wrap, widths, i) as %String
• classmethod wrappedWidth(val) as %Integer


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.