Package com.microstrategy.web.app.gui

Interface SubscriptionWidget

All Superinterfaces:

DefaultSubscriptionWidget, GuiElement

All Known Subinterfaces:

SubscriptionFileWidget, SubscriptionPrintWidget

All Known Implementing Classes:

SubscriptionFileWidgetImpl, SubscriptionPrintWidgetImpl

public interface SubscriptionWidget
extends DefaultSubscriptionWidget

Deprecated.

Please use SubscriptionWidget from the transforms package.

Renders the Widget to create/edit Narrowcast Subscriptions.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static int	ADDRESS_CONTACT	Deprecated.
static int	ADDRESS_EXISTING	Deprecated. Constant to indicate an existing address
static int	ADDRESS_NEW	Deprecated. Constant to indicate new address

Method Summary

Modifier and Type	Method	Description
boolean	getIsSendNowAvailable()	Deprecated.
java.lang.String	getSendNowArg()	Deprecated.
java.lang.String	getTriggerArg()	Deprecated.
java.lang.String	getTriggerId()	Deprecated.
SimpleList	getTriggers()	Deprecated.
boolean	isSendNowSet()	Deprecated.
void	renderTriggerList(MarkupOutput out, SimpleList triggers, java.lang.String triggerId, java.lang.String argTrigger)	Deprecated. Renders the list of triggers for the Subscriptions.
void	setIsSendNowAvailable(boolean value)	Deprecated. Set to true if the the feature for Send Now is available
void	setSendNow(boolean value)	Deprecated. Indicated whether to send a preview of the subscription now.
void	setSendNowArg(java.lang.String value)	Deprecated. The sendNow's argument name.
void	setTriggerArg(java.lang.String value)	Deprecated. The name of the triggerId argument
void	setTriggerId(java.lang.String value)	Deprecated. Sets the id of the current trigger
void	setTriggers(SimpleList value)	Deprecated. Sets the global list of Triggers

Methods inherited from interface com.microstrategy.web.app.gui.DefaultSubscriptionWidget

getAddressArg, getAddresses, getAddressId, getAddressTypeArg, getAvailableFormats, getAvailableLocations, getChangeableMask, getCompressed, getCompressedArg, getCompressedFileName, getCompressedFileNameArg, getCurrentFormat, getCustomMessage, getCustomMessageArg, getDeviceArg, getDeviceId, getDevices, getExpandPageBy, getExpandPageByArg, getExpandUseSeparateSheets, getExpandUseSeparateSheetsArg, getExpirationDate, getFileName, getFileNameArg, getFormatArg, getImageBasePath, getInitialiIndent, getIsCreateEmailAvailable, getIsCustomMessageAvailable, getIsExpandPageByAvailable, getIsRWD, getLocationArg, getLocationID, getNewAddressArg, getNewAddressValue, getObjectName, getOpenAddressesEvent, getSubject, getSubjectArg, getSubscriptionObjectType, getSubscriptionObjectViewType, getZipPassword, isIncludeDataSet, isIncludeLinkSet, isProtectZipFile, isSendToInboxSet, renderAddressList, renderCustomMessageField, renderObjectName, renderSubjectField, setAddressArg, setAddresses, setAddressId, setAddressTypeArg, setAllowChangeDeliverySettingsArg, setAllowChangePersonalizationArg, setAllowUnsubscribeArg, setAvailableFormats, setAvailableLocations, setChangeableMask, setCompressed, setCompressedArg, setCompressedFileName, setCompressedFileNameArg, setCurrentFormat, setCustomMessage, setCustomMessageArg, setDeviceArg, setDeviceId, setDevices, setExpandPageBy, setExpandPageByArg, setExpandUseSeparateSheets, setExpandUseSeparateSheetsArg, setExpirationDate, setExpirationDateArg, setFileName, setFileNameArg, setFormatArg, setImageBasePath, setIncludeData, setIncludeDataArg, setIncludeLink, setIncludeLinkArg, setInitialiIndent, setIsCreateEmailAvailable, setIsCustomMessageAvailable, setIServerAsNCSSource, setIsExpandPageByAvailable, setIsRWD, setLocationArg, setLocationID, setNewAddressArg, setNewAddressValue, setObjectName, setOpenAddressesEvent, setOpenContactsBrowser, setOpenContactsBrowserEvent, setProtectZipFile, setProtectZipFileArg, setSendToInbox, setSendToInboxArg, setSubject, setSubjectArg, setSubscriptionObjectType, setSubscriptionObjectViewType, setZipPassword, setZipPasswordArg

Methods inherited from interface com.microstrategy.web.app.gui.GuiElement

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getUseIFrame, getWebComponent, renderElement, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

Field Detail

ADDRESS_EXISTING

static final int ADDRESS_EXISTING

Deprecated.

Constant to indicate an existing address

See Also:

Constant Field Values

ADDRESS_NEW

static final int ADDRESS_NEW

Deprecated.

Constant to indicate new address

See Also:

Constant Field Values

ADDRESS_CONTACT

static final int ADDRESS_CONTACT

Deprecated.

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Method Detail

renderTriggerList

void renderTriggerList(MarkupOutput out,
                       SimpleList triggers,
                       java.lang.String triggerId,
                       java.lang.String argTrigger)

Deprecated.

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

setTriggers

void setTriggers(SimpleList value)

Deprecated.

Sets the global list of Triggers

Parameters:

value - the new list of Triggers

getTriggers

SimpleList getTriggers()

Deprecated.

Returns:

the current global list of triggers.

setTriggerId

void setTriggerId(java.lang.String value)

Deprecated.

Sets the id of the current trigger

Parameters:

value - the new value for the current trigger

getTriggerId

java.lang.String getTriggerId()

Deprecated.

Returns:

the current triggerId value

setIsSendNowAvailable

void setIsSendNowAvailable(boolean value)

Deprecated.

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

Parameters:

value - true if the send now feature is available

getIsSendNowAvailable

boolean getIsSendNowAvailable()

Deprecated.

Returns:

true if the send now feature is available.

setSendNow

void setSendNow(boolean value)

Deprecated.

Indicated whether to send a preview of the subscription now.

Parameters:

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

isSendNowSet

boolean isSendNowSet()

Deprecated.

Returns:

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

setTriggerArg

void setTriggerArg(java.lang.String value)

Deprecated.

The name of the triggerId argument

Parameters:

value - the new name for the triggerId argument

getTriggerArg

java.lang.String getTriggerArg()

Deprecated.

Returns:

The name of the triggerId argument

setSendNowArg

void setSendNowArg(java.lang.String value)

Deprecated.

The sendNow's argument name.

Parameters:

value - The new sendNow argument name.

getSendNowArg

java.lang.String getSendNowArg()

Deprecated.

Returns:

The sendNow argument name.