CSPX.EnsMsgSearchForm

class CSPX.EnsMsgSearchForm extends %Library.RegisteredObject, %CSP.Util.AutoForm

An autoform for gathering Message Filter info

Property Inventory

MaxRows
Query

Method Inventory

CreateInstance()
DrawHTMLForm()
OnDefineButtons()
OnSubmit()

Parameters

parameter DOMAIN = Ensemble;

Use our own domain for localization

Properties

property MaxRows as %Integer (MINVAL = 1);

Property methods: MaxRowsDisplayToLogical(), MaxRowsGet(), MaxRowsIsValid(), MaxRowsLogicalToDisplay(), MaxRowsNormalize(), MaxRowsSet()

property Query as %String (CAPTION = "Query", MAXLEN = 500);

Message status

Property methods: QueryDisplayToLogical(), QueryGet(), QueryIsValid(), QueryLogicalToDisplay(), QueryLogicalToOdbc(), QueryNormalize(), QuerySet()

Methods

classmethod CreateInstance(ByRef pID As %String) as %CSP.Util.AutoForm

Number of rows to display

classmethod DrawHTMLForm(pObj As %RegisteredObject, ByRef pID As %String, pActionURL As %String = "", ByRef pButtons As FormButton, pTarget As %String = "") as %Status

Draw an HTML form for this form object.
pObj is an instance of the form object that provides the initial values for the form.
pActionURL is the URL to submit this form to.
pButtons is an array of submit buttons to display for the form. If not provided, the default Save and Cancel buttons are shown. pButtons is an integer-subscripted array of FormButton objects.

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