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

CSPX.EnsMAPurgeForm

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

A simple login AutoForm class...

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DOMAIN = Ensemble;
Use our own domain for localization
parameter RefreshRate = 4;
Default refresh rate in seconds

Properties (Including Private)

property BodiesToo as %Boolean [ InitialExpression = 0 ];
Property methods: BodiesTooDisplayToLogical(), BodiesTooGet(), BodiesTooIsValid(), BodiesTooLogicalToDisplay(), BodiesTooNormalize(), BodiesTooSet()
property KeepIntegrity as %Boolean [ InitialExpression = 1 ];
Property methods: KeepIntegrityDisplayToLogical(), KeepIntegrityGet(), KeepIntegrityIsValid(), KeepIntegrityLogicalToDisplay(), KeepIntegrityNormalize(), KeepIntegritySet()
property NumberDaysToKeep as %Integer [ InitialExpression = 7 ];
Purge except this number of days
Property methods: NumberDaysToKeepDisplayToLogical(), NumberDaysToKeepGet(), NumberDaysToKeepIsValid(), NumberDaysToKeepLogicalToDisplay(), NumberDaysToKeepNormalize(), NumberDaysToKeepSet()

Methods (Including Private)

classmethod BackgroundPurge(daysToKeep, keepIntegrity, bodiesToo)
classmethod CreateInstance(ByRef pID As %String) as %CSP.Util.AutoForm
Event Log Max Number to Delete
classmethod DrawHTMLForm(pObj As %RegisteredObject, ByRef pID As %String, pActionURL As %String = "", ByRef pButtons As %CSP.Util.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 standard Login 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)