Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.PubSub.SubscriptionForm
Private  Storage   

EnsLib.PubSub.SubscriptionForm


class EnsLib.PubSub.SubscriptionForm extends
%RegisteredObject, %CSP.Util.AutoForm

Form object used to create a new subscription.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 2 2


Summary


Properties
Subscriber Topic

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

Properties


• property Subscriber as %CSP.Util.Choice(CAPTION="Domain / Subscriber",CAPTIONCOLUMN="Name",QUERYCLASS="EnsLib.PubSub.Subscriber",QUERYNAME="SubscriberList",VALUECOLUMN="ID");
• property Topic as %String(MAXLEN=128);

Methods


• classmethod CreateInstance(ByRef pID As %String) as SubscriptionForm
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.
• 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).