Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / CSPX.EnsMsgTablePane
Private  Storage   

CSPX.EnsMsgTablePane


class CSPX.EnsMsgTablePane extends
CSPX.SQLQueryPane, Ens.Util.FunctionSet

Specialized pane for displaying a list of messages.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 17 1


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
Contains ConvertDateTime CreateDataSet CreateResultSet
CreateTempFile CurrentDateTime DoesNotContain DoesNotIntersectList
DoesNotMatch DoesNotStartWith DrawBODY DrawCommandForm
DrawCommands DrawHEAD DrawLastUpdate DrawSearch
DrawStatusError DrawTable DumpTree EnumerateClose
EnumerateExecute EnumerateFetch EnumerateGetInfo EnumeratePrepare
ExecuteResultSet Exists FilterPostRS FilterTable
GenerateCode GetColorByColumn GetColumnWidths GetDescriptiveText
GetItemsPerPage GetLinks GetToolTips If
In InFile InFileColumn IntersectsList
ItemsPerPageUpdate Length Like LocalizeColumnName
LocalizeText Lookup MakeLink Matches
Max Min Not NotIn
NotInFile NotLike OnDrawFilter OnDrawHEADTablePane
OnGenerateCode Pad Piece PurgeTempData
QuoteCOS RefreshTable RegexMatch ReplaceStr
Round Rule Schedule StartsWith
Strip SubString ToLower ToUpper
Translate XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addSQLTerms filtPostRS parseTerms
reduceTree replace wrapHTML wrappedWidth

Subclasses
CSPX.EnsEntMsgTablePane CSPX.EnsMsgTablePaneEx CSPX.Enterprise.Portal.MsgTablePane

Parameters


• parameter IDCOL = "ID";
Name of ID Column if "More Data" link is to be offered ($NextID variable must be supported in CreateResultSet() also)
• parameter TOPCOUNT = 10000000;
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.

Methods


• method CreateResultSet(ByRef pID As %String, ByRef pRS As %ResultSet) as %Status
This method creates the %ResultSet object that is used for the table pane.
A subclass can override this to customize the table displayed by this pane.
pID is array of page variables...
• method DrawBODY(pInstance As %CSP.Util.PageInstance) as %Status
Override this method from the superclass to check if there is an error in the Start Time and/or End Time fields and display this error instead of running the query.
• method DrawHEAD(pInstance As PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the HEAD section.
• method DumpTree(pWeb=1, level=1, tNode=1)
• classmethod EnumerateClose(ByRef qHandle As %Binary) as %Status
• classmethod EnumerateExecute(ByRef qHandle As %Binary, pFilterObj As CSPX.EnsMsgFilterForm, pNextId As %String = "", pPaneObj As EnsMsgTablePane = $$$NULLOREF) as %Status
• classmethod EnumerateFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod EnumerateGetInfo(colinfo As %List, parminfo As %List, idinfo As %List, qHandle As %Binary, extoption As %Integer = 0, extinfo As %List) as %Status
• classmethod EnumeratePrepare(ByRef qHandle As %Binary, p1 As %String, p2 As %Integer, p3 As %String) as %Status
• 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, level=1, tNode="1", pInOR=0) 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. pPropVals is an array of calculated property values to extend the display list if the filter passes.
• method GetColorByColumn() as %String
Subclass can override this to specify the name of column used to distinctly color rows
• method GetLinks(ByRef pValues, ByRef pLinks)
Subclass can override this to specify hyperlinks for the columns
• method addSQLTerms(ByRef aSelect, ByRef aFrom, Output xWhere, level=1, tNode="1") as %Integer
Take from Terms tree whatever is best added to the SQL statement Return 0 means no SQL for node, 1 means node was partly done in SQL, 2 means node was completely accounted for in SQL
• method filtPostRS(pFilterObj As CSPX.EnsMsgFilterForm, pRS As %ResultSet, ByRef pPropVals, level=1, tNode="1", pInOR=0) 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. pPropVals is an array of calculated property values to extend the display list if the filter passes.
• method parseTerms(pFilterObj As CSPX.EnsMsgFilterForm) as %Status
Parse the list of filter terms and conditions into a local tree
• method reduceTree()
Reduce Terms tree if possible by eliminating common terms

Queries


• query Enumerate(FilterObj As CSPX.EnsMsgFilterForm, NextId As %String = "", PaneObj As EnsMsgTablePane = $$$NULLOREF)
Selects ID, TimeCreated, Session, Status, Error, Source
List the messages matching the given filter object, skipping to start from NextId if given.