This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > CSPX.EnsBPInstanceFilterForm


class CSPX.EnsBPInstanceFilterForm extends %Library.RegisteredObject, CSPX.AutoFormCSP

An autoform for gathering Rule Log Filter info

Property Inventory (Including Private)

Method Inventory (Including Private)


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

Properties (Including Private)

property BusinessProcess as %CSP.Util.Choice (CAPTION = "Business Process Class", CAPTIONCOLUMN = "Name", P1 = "Ens.BusinessProcess", QUERYCLASS = "%Dictionary.ClassDefinition", QUERYNAME = "SubclassOf");
BP class
Property methods: BusinessProcessDisplayToLogical(), BusinessProcessGet(), BusinessProcessIsValid(), BusinessProcessLogicalToDisplay(), BusinessProcessLogicalToOdbc(), BusinessProcessNormalize(), BusinessProcessSet()
property EndTime as %TimeStamp (CAPTION = "End Time");
End date
Property methods: EndTimeDisplayToLogical(), EndTimeGet(), EndTimeIsValid(), EndTimeLogicalToDisplay(), EndTimeNormalize(), EndTimeOdbcToLogical(), EndTimeSet()
property MaxRows as %Integer (CAPTION = "Max Rows", MAXVAL = 500, MINVAL = 1) [ InitialExpression = 100 ];
Number of rows to display
Property methods: MaxRowsDisplayToLogical(), MaxRowsGet(), MaxRowsIsValid(), MaxRowsLogicalToDisplay(), MaxRowsNormalize(), MaxRowsSet()
property SortOrder as %String (CAPTION = "Sort Order", DISPLAYLIST = ",Oldest First,Newest First", VALUELIST = ",1,2");
How to sort data
Property methods: SortOrderDisplayToLogical(), SortOrderGet(), SortOrderIsValid(), SortOrderLogicalToDisplay(), SortOrderLogicalToOdbc(), SortOrderNormalize(), SortOrderSet()
property StartTime as %TimeStamp (CAPTION = "Start Time");
Starting date
Property methods: StartTimeDisplayToLogical(), StartTimeGet(), StartTimeIsValid(), StartTimeLogicalToDisplay(), StartTimeNormalize(), StartTimeOdbcToLogical(), StartTimeSet()
property TimeFormat as %String (CAPTION = "Time Format", DISPLAYLIST = ",Time Only,Complete", VALUELIST = ",12,999");
Time format
Property methods: TimeFormatDisplayToLogical(), TimeFormatGet(), TimeFormatIsValid(), TimeFormatLogicalToDisplay(), TimeFormatLogicalToOdbc(), TimeFormatNormalize(), TimeFormatSet()

Methods (Including Private)

classmethod CreateInstance(ByRef pID As %String) as %CSP.Util.AutoForm
Inherited description: 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
Inherited description: 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).

Inherited Members

Inherited Methods (Including Private)