Home > Class Reference > ENSLIB namespace > CSPX.EnsMAPurgeForm
Private  Storage   


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

A simple login AutoForm class...


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 3 5


BodiesToo KeepIntegrity NumberDaysToKeep

%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
BackgroundPurge CreateInstance DispatchSubmit DoSubmit
DrawFormButtons DrawHTMLForm DrawHTMLTable GetComboBoxHTML
GetFormError OnDefineButtons OnSubmit ProcessSubmit
SetFormError Submit


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


• property BodiesToo as %Boolean [ InitialExpression = 0 ];
• property KeepIntegrity as %Boolean [ InitialExpression = 1 ];
• property NumberDaysToKeep as %Integer [ InitialExpression = 7 ];
Purge except this number of days


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