EnsLib.ITK.Setup.UI.EditSubscriptions

class EnsLib.ITK.Setup.UI.EditSubscriptions extends EnsPortal.Dialog.standardDialog

Property Inventory

Method Inventory

Parameters

parameter APPLICATION = EnsPortal.Application;
Enable styles that are common to all pages and dialogs for the EnsPortal application.
parameter APPLYBUTTON = 1;
Inherited description: If true, then this dialog displays an Apply button.
parameter CANCELBUTTON = 1;
Inherited description: If true, then this dialog displays a Cancel button.
parameter EDITRESOURCE = %Ens_ITK:WRITE;
Inherited description: Resource for subclasses to indicate whether further resources are needed to perform actions on pages.
parameter PAGENAME = Edit Subscriptions;
Inherited description: Optional. This is the display name used for this page. If not provided, the class name is used.
parameter RESOURCE = %Ens_ITK:READ;
Inherited description: This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties

property Consumer as %String;
Property methods: ConsumerDisplayToLogical(), ConsumerGet(), ConsumerIsValid(), ConsumerLogicalToDisplay(), ConsumerLogicalToOdbc(), ConsumerNormalize(), ConsumerSet()
property ItemNo as %String (ZENURL = "itemNo");
Property methods: ItemNoDisplayToLogical(), ItemNoGet(), ItemNoIsValid(), ItemNoLogicalToDisplay(), ItemNoLogicalToOdbc(), ItemNoNormalize(), ItemNoSet()
property Sender as %String;
Property methods: SenderDisplayToLogical(), SenderGet(), SenderIsValid(), SenderLogicalToDisplay(), SenderLogicalToOdbc(), SenderNormalize(), SenderSet()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Avoid writing out the session cookie if we are in a Studio session.
method %OnGetSubtitle() as %String [ Language = objectscript ]
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod GetHyperEventResources(pMethod As %String = "") as %String [ Language = objectscript ]
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
classmethod GetSubscriptions(pSender As %String, pConsumer As %String) as %ListOfDataTypes [ Language = objectscript, ZenMethod ]
method StoreSubscriptions(pSelectedRows As %String) as %Status [ Language = objectscript, ZenMethod ]
clientmethod getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod loadSelectedRows() [ Language = javascript ]
clientmethod ondialogFinish(action) [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod rowMultiSelected(table) [ Language = javascript ]
User multi-selected a new row in the table

Inherited Members

Inherited Properties

Inherited Methods

Feedback