InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > EnsLib.PubSub.SubscriptionForm

EnsLib.PubSub.SubscriptionForm

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

Form object used to create a new subscription.

Property Inventory

Method Inventory

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 methods: SubscriberDisplayToLogical(), SubscriberGet(), SubscriberIsValid(), SubscriberLogicalToDisplay(), SubscriberLogicalToOdbc(), SubscriberNormalize(), SubscriberSet()
property Topic as %String (MAXLEN = 128);
Property methods: TopicDisplayToLogical(), TopicGet(), TopicIsValid(), TopicLogicalToDisplay(), TopicLogicalToOdbc(), TopicNormalize(), TopicSet()

Methods

classmethod CreateInstance(ByRef pID As %String) as SubscriptionForm [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
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

Feedback