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

CSPX.EnsPurgeForm


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

Generic form for individual purge form

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 1 4


Summary


Properties
NumberDaysToKeep

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
DrawHTMLForm DrawHTMLTable GetComboBoxHTML GetFormError
OnDefineButtons OnSubmit ProcessSubmit SetFormError
Submit


Parameters


• parameter DOMAIN = "Ensemble";
Use our own domain for localization
• parameter FORMCOLUMNS = 1;
Number of columns used to layout forms for this class

Properties


• property NumberDaysToKeep as %Integer [ InitialExpression = 7 ];
Purge excapt this number of days

Methods


• classmethod CreateInstance(ByRef pID As %String) as %CSP.Util.AutoForm
Purge Event Logs 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 purge button for event log
• 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).