public interface

SubscriptionWidget

implements DefaultSubscriptionWidget
com.microstrategy.web.app.gui.SubscriptionWidget
Known Indirect Subclasses

This interface is deprecated.
Please use SubscriptionWidget from the transforms package.

Class Overview

Renders the Widget to create/edit Narrowcast Subscriptions.

Summary

Constants
int ADDRESS_CONTACT
int ADDRESS_EXISTING Constant to indicate an existing address
int ADDRESS_NEW Constant to indicate new address
Public Methods
abstract boolean getIsSendNowAvailable()
abstract String getSendNowArg()
abstract String getTriggerArg()
abstract String getTriggerId()
abstract SimpleList getTriggers()
abstract boolean isSendNowSet()
abstract void renderTriggerList(MarkupOutput out, SimpleList triggers, String triggerId, String argTrigger)
Renders the list of triggers for the Subscriptions.
abstract void setIsSendNowAvailable(boolean value)
Set to true if the the feature for Send Now is available
abstract void setSendNow(boolean value)
Indicated whether to send a preview of the subscription now.
abstract void setSendNowArg(String value)
The sendNow's argument name.
abstract void setTriggerArg(String value)
The name of the triggerId argument
abstract void setTriggerId(String value)
Sets the id of the current trigger
abstract void setTriggers(SimpleList value)
Sets the global list of Triggers
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.gui.DefaultSubscriptionWidget
From interface com.microstrategy.web.app.gui.GuiElement

Constants

public static final int ADDRESS_CONTACT

Constant Value: 2 (0x00000002)

public static final int ADDRESS_EXISTING

Constant to indicate an existing address

Constant Value: 0 (0x00000000)

public static final int ADDRESS_NEW

Constant to indicate new address

Constant Value: 1 (0x00000001)

Public Methods

public abstract boolean getIsSendNowAvailable ()

Returns
  • true if the send now feature is available.

public abstract String getSendNowArg ()

Returns
  • The sendNow argument name.

public abstract String getTriggerArg ()

Returns
  • The name of the triggerId argument

public abstract String getTriggerId ()

Returns
  • the current triggerId value

public abstract SimpleList getTriggers ()

Returns
  • the current global list of triggers.

public abstract boolean isSendNowSet ()

Returns
  • true if a preview will be sent immediatly after creating the subscription.

public abstract void renderTriggerList (MarkupOutput out, SimpleList triggers, String triggerId, String argTrigger)

Renders the list of triggers for the Subscriptions. This method can be called stand alone by passing the required arguments. It's also part of the renderElement() method that passes the global widget values properties as the arguments.

Parameters
out Where to write the widget's output
triggers the list of triggers
triggerId the current triggerId
argTrigger the name of the triggerId argument

public abstract void setIsSendNowAvailable (boolean value)

Set to true if the the feature for Send Now is available

Parameters
value true if the send now feature is available

public abstract void setSendNow (boolean value)

Indicated whether to send a preview of the subscription now.

Parameters
value true if a preview will be sent immediatly after creating the subscription.

public abstract void setSendNowArg (String value)

The sendNow's argument name.

Parameters
value The new sendNow argument name.

public abstract void setTriggerArg (String value)

The name of the triggerId argument

Parameters
value the new name for the triggerId argument

public abstract void setTriggerId (String value)

Sets the id of the current trigger

Parameters
value the new value for the current trigger

public abstract void setTriggers (SimpleList value)

Sets the global list of Triggers

Parameters
value the new list of Triggers