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

CSPX.EnsMsgFilterForm


persistent class CSPX.EnsMsgFilterForm extends
%Persistent, %XML.Adaptor, %CSP.Page, CSPX.AutoFormCSP

An autoform for gathering VDoc Message Filter info and storing and transmitting it * note - nasty hack: Inherit from %CSP.Page to get #server() work even though we are a pane ;) */

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 18 12 1


Summary


Properties
%Description %Name %Terms ColorBy EndId
EndTime IsError MaxRows RuntimeMode SortOrder
Source StartId StartTime Status TermsStr
TimeFormat Timeout Type

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %BuildIndicesAsync
%BuildIndicesAsyncResponse %CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion
%ClassName %ComposeOid %ConstructClone %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Exists %ExistsId %Extends
%GUID %GUIDSet %GetLock %GetParameter
%GetSwizzleObject %Id %InsertBatch %IsA
%IsModified %IsNull %KillExtent %KillExtentData
%LoadFromMemory %LockExtent %LockId %New
%NormalizeObject %ObjectIsNull %ObjectModified %Oid
%OnBeforeAddToSync %OnDetermineClass %Open %OpenId
%OriginalNamespace %PackageName %PhysicalAddress %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SaveIndices %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject ConvertParameter CreateInstance Decrypt
DispatchSubmit DoSubmit DrawFormButtons DrawHEADExtra
DrawHTMLExtra DrawHTMLForm DrawHTMLTable Encrypt
EscapeHTML EscapeURL GetComboBoxHTML GetFormError
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate JavaScript1 JavaScript2
Link NextTerm OnDefineButtons OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent OnSubmit Page
ProcessSubmit QuoteJS RewriteURL SetFormError
ShowError StartTimer StopTimer Styles
Submit ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
cleanReqData isDefaultNewTerm jsGenerate


Parameters


• parameter FORMCOLUMNS = 3;
Number of columns used to layout forms for this class
• parameter FunctionList = ",=,!=,>,>=,<,<=,Contains,DoesNotContain,In,NotIn,StartsWith,DoesNotStartWith,Like,NotLike,Matches,DoesNotMatch,InFile,NotInFile";
• parameter XMLNAME = "MsgFilter";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties


• property %Description as %String(MAXLEN=2000,XMLNAME="description",XMLPROJECTION="element") [ SqlFieldName = _Description ];
Optional description of this MsgFilter Definition.
• property %Name as %String(MAXLEN=128,XMLNAME="Name",XMLPROJECTION="attribute") [ Required ];
The name of this MsgFilter Definition.
• property %Terms as list of EnsPortal.MsgFilter.Term(XMLNAME="Term",XMLPROJECTION="element");
Set of detailed condition terms in the MsgFilter.
• property ColorBy as %String(CAPTION="@Ensemble:ColorBy@Color By",VALUELIST=",TimeCreated,SessionId,Status,Error,Source");
Column to color results by
• property EndId as %Integer(CAPTION="@Ensemble:EndId@End Id");
End ID value
• property EndTime as %String(CAPTION="@Ensemble:EndTime@End Time");
End date
• property IsError as %String(CAPTION="@Ensemble:IsError@Is Error",DISPLAYLIST=",false,true",VALUELIST=",0,1");
Errors
• property MaxRows as %Integer(CAPTION="@Ensemble:MaxRows@Max Rows",MINVAL=1);
Number of rows to display
• property RuntimeMode as %String [ InitialExpression = 2,Transient ];
Runtime mode to use (controls use of Logical/ODBC/Display values)
• property SortOrder as %String(CAPTION="@Ensemble:SortOrder@Sort Order",DISPLAYLIST=",Oldest First,Newest First",VALUELIST=",1,2") [ InitialExpression = 2 ];
How to sort data
• property Source as %String(CAPTION="@Ensemble:Source@Source",MAXLEN=128);
Source
• property StartId as %Integer(CAPTION="@Ensemble:StartId@Start Id");
Starting ID value
• property StartTime as %String(CAPTION="@Ensemble:StartTime@Start Time");
Starting date
• property Status as Ens.DataType.MessageStatus(CAPTION="@Ensemble:Status@Status");
Message status
• property TermsStr as %String(MAXLEN="") [ Transient ];
Serialized set of detailed condition terms from the filter info pane
• property TimeFormat as %String(CAPTION="@Ensemble:TimeFormat@Time Format",DISPLAYLIST=",Time Only,Complete",VALUELIST=",12,999") [ InitialExpression = 12 ];
Time format
• property Timeout as %Numeric [ Transient ];
Timeout to quit doing PostRS checks from within TablePane:EnumerateFetch query
• property Type as %String(CAPTION="@Ensemble:Type@Type",DISPLAYLIST=",Session Start,Request,Response,All",VALUELIST=",0,1,2,3") [ InitialExpression = 0 ];
Message types

Methods


• classmethod CreateInstance(ByRef pID As %String) as %CSP.Util.AutoForm
Create an instance of the AutoForm object using the provided ID value(s). This is overridden by subclasses.
The default implementation will perform an OpenId if the AutoForm is a persistent object.
• method DrawHEADExtra(pInstance As %CSP.Util.PageInstance) as %Status
• method DrawHTMLExtra(ByRef pID As %String, pActionURL As %String = "", ByRef pButtons As FormButton, pTarget As %String = "") as %Status
• classmethod JavaScript1(tVDocName)
• classmethod JavaScript2(tDefTermType, tDefClass, tDefProp, tVDocName, tVDocClass, tSearchTableClass)
• method NextTerm(ByRef iTerm) as EnsPortal.MsgFilter.Term
Find the next valid term in the terms list, skipping over adjacent OR's and leading or trailing OR's
• classmethod OnDefineButtons(ByRef pButtons As %CSP.Util.FormButton)
define buttons
• method OnSubmit(ByRef pID As %String, pSubmit As %String) as %Status
This callback is called when this form is submitted. pID is the ID value associated with the form. The default implementation will perform a Save if the AutoForm is a persistent object.
pSubmit is the name of the submit button (i.e., $AUTOFORM_SAVE).
• classmethod Styles()
• classmethod cleanReqData(pContextOnly As %Boolean = 0)
• classmethod isDefaultNewTerm(pTerm, tVDocName, tSearchTableClass) as %Boolean
• classmethod jsGenerate(tMsgFilter, tVDocName, tSearchTableClass)

Indices


•index (Name on %Name) [IdKey];