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

CSPX.EnsRuleLogFilterForm


class CSPX.EnsRuleLogFilterForm extends
%RegisteredObject, CSPX.AutoFormCSP

An autoform for gathering Rule Log Filter info

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 9 3


Summary


Properties
ColorBy EndTime HostClass MaxRows RuleName
SessionId SortOrder StartTime TimeFormat

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
CreateInstance DispatchSubmit DoSubmit DrawFormButtons
DrawHEADExtra DrawHTMLExtra DrawHTMLForm DrawHTMLTable
GetComboBoxHTML GetFormError OnDefineButtons OnSubmit
ProcessSubmit SetFormError Submit


Parameters


• parameter FORMCOLUMNS = 2;
Number of columns used to layout forms for this class

Properties


• property ColorBy as %String(CAPTION="@Ensemble:ColorBy@Color By",VALUELIST=",Session,TimeExecuted,HostClass,Activity,Rule,Reason,Return,IsError,ErrorMsg,RoutineName");
Column to color results by
• property EndTime as %String(CAPTION="@EnsColumns:EndTime@End Time");
End date
• property HostClass as %String(CAPTION="@EnsColumns:PackageName@Package Name");
Host class #; YSD2201 Property HostClass As %CSP.Util.Choice(CAPTION = "@EnsColumns:PackageName@Package Name", CAPTIONCOLUMN = "Name", P1 = "Ens.BusinessProcessBPL", QUERYCLASS = "%Dictionary.ClassDefinition", QUERYNAME = "SubclassOf");
• property MaxRows as %Integer(CAPTION="@Ensemble:MaxRows@Max Rows",MAXVAL=500,MINVAL=1) [ InitialExpression = 100 ];
Number of rows to display
• property RuleName as %CSP.Util.Choice(CAPTION="@EnsColumns:RuleName@Rule Name",CAPTIONCOLUMN="Name",QUERYCLASS="Ens.Rule.RuleDefinition",QUERYNAME="EnumerateRuleNames");
Rule Name
• property SessionId as %Integer(CAPTION="@Ensemble:SessionId@Session Id");
Session ID
• property SortOrder as %String(CAPTION="@Ensemble:SortOrder@Sort Order",DISPLAYLIST=",Oldest First,Newest First",VALUELIST=",1,2");
How to sort data
• property StartTime as %String(CAPTION="@Ensemble:StartTime@Start Time");
Starting date
• property TimeFormat as %String(CAPTION="@Ensemble:TimeFormat@Time Format",DISPLAYLIST=",Time Only,Complete",VALUELIST=",12,999");
Time format

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.
• 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).