public interface

DefaultSubscriptionWidget

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

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

Class Overview

Title: DefaultSubscriptionWidget.

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

Summary

Public Methods
abstract String getAddressArg()
abstract String getAddressId()
This method is deprecated. replaced by getLocationID()
abstract String getAddressTypeArg()
abstract SimpleList getAddresses()
abstract SimpleList getAvailableFormats()
Returns all the available formats for subscription in this system.
abstract SimpleList getAvailableLocations()
abstract int getChangeableMask()
value from EnumDSSXMLNCSAllowChangeMaskType
abstract boolean getCompressed()
Returns true if the current subscription is supposed to be delivered in the compressed(zipped) format.
abstract String getCompressedArg()
abstract String getCompressedFileName()
abstract String getCompressedFileNameArg()
abstract WebSubscriptionContentFormat getCurrentFormat()
Returns the current format for this subscription used when creating the subscription.
abstract String getCustomMessage()
abstract String getCustomMessageArg()
abstract String getDeviceArg()
abstract String getDeviceId()
abstract SimpleList getDevices()
abstract int getExpandPageBy()
abstract String getExpandPageByArg()
abstract int getExpandUseSeparateSheets()
abstract String getExpandUseSeparateSheetsArg()
abstract String getExpirationDate()
abstract String getFileName()
abstract String getFileNameArg()
abstract String getFormatArg()
abstract String getImageBasePath()
abstract int getInitialiIndent()
abstract boolean getIsCreateEmailAvailable()
abstract boolean getIsCustomMessageAvailable()
abstract boolean getIsExpandPageByAvailable()
abstract boolean getIsRWD()
abstract String getLocationArg()
abstract String getLocationID()
abstract String getNewAddressArg()
abstract String getNewAddressValue()
abstract String getObjectName()
abstract WebEvent getOpenAddressesEvent()
abstract String getSubject()
abstract String getSubjectArg()
abstract int getSubscriptionObjectType()
Returns if the current subscription is for a report or for a document.
abstract int getSubscriptionObjectViewType()
Returns the view mode for the object.
abstract String getZipPassword()
abstract boolean isIncludeDataSet()
abstract boolean isIncludeLinkSet()
abstract boolean isProtectZipFile()
abstract boolean isSendToInboxSet()
abstract void renderAddressList(MarkupOutput out, SimpleList addresses, String addressId, String addressArg, String addressTypeArg, String newAddressValue, String newAddressArg, SimpleList devices, String deviceId, String deviceArg)
Renders the list of addresses for the e-mail.
abstract void renderCustomMessageField(MarkupOutput out, String message, String argMessage)
Renders a field for the Custom Message which can be sent along with the e-mail sent with the given addresses.
abstract void renderObjectName(MarkupOutput out, String name)
Renders the name of the object for which the subscription is being created.
abstract void renderSubjectField(MarkupOutput out, String subject, String argSubject)
Renders a field for the Subject's of the e-mail sent with the given addresses.
abstract void setAddressArg(String value)
The name of the adressId argument
abstract void setAddressId(String value)
This method is deprecated. replaced by setLocationID(String)
abstract void setAddressTypeArg(String value)
The name of the adressType argument.
abstract void setAddresses(SimpleList value)
The global list of addresses to use for this subscription
abstract void setAllowChangeDeliverySettingsArg(String arg)
abstract void setAllowChangePersonalizationArg(String arg)
abstract void setAllowUnsubscribeArg(String arg)
abstract void setAvailableFormats(SimpleList availableFormats)
Sets all the available formats for subscription in this system.
abstract void setAvailableLocations(SimpleList value)
Sets the list of available locations for the file subscription.
abstract void setChangeableMask(int mask)
value from EnumDSSXMLNCSAllowChangeMaskType
abstract void setCompressed(boolean compressed)
Sets if the current subscription is supposed to be delivered in the compressed(zipped) format.
abstract void setCompressedArg(String value)
The argument name to for the Compressed value.
abstract void setCompressedFileName(String fileName)
abstract void setCompressedFileNameArg(String fileNameArg)
abstract void setCurrentFormat(WebSubscriptionContentFormat currentFormat)
Sets the current format for this subscription used when creating the subscription.
abstract void setCustomMessage(String value)
Sets the text to use as the message line of the email subscriptions sent.
abstract void setCustomMessageArg(String value)
The Message's argument name.
abstract void setDeviceArg(String value)
The name of the deviceId argument.
abstract void setDeviceId(String value)
The current deviceId.
abstract void setDevices(SimpleList value)
Sets the global list of devices to use for new addresses
abstract void setExpandPageBy(int value)
The value for the expand pageBy.
abstract void setExpandPageByArg(String value)
The argument name for the expand pageBy.
abstract void setExpandUseSeparateSheets(int value)
The value for the expand use separate sheets.
abstract void setExpandUseSeparateSheetsArg(String value)
The argument name for the use separate sheets.
abstract void setExpirationDate(String expirationDate)
abstract void setExpirationDateArg(String arg)
abstract void setFileName(String fileName)
abstract void setFileNameArg(String fileNameArg)
abstract void setFormatArg(String value)
The Format's argument name.
abstract void setIServerAsNCSSource()
used to convey to the widget that IServer is hosting the ncs functionality.
abstract void setImageBasePath(String value)
The name of the base path for images
abstract void setIncludeData(boolean includeData)
abstract void setIncludeDataArg(String arg)
abstract void setIncludeLink(boolean includeLink)
abstract void setIncludeLinkArg(String arg)
abstract void setInitialiIndent(int value)
Defines the initial indent the widget uses to render the content
abstract void setIsCreateEmailAvailable(boolean value)
Set to true if the feature for creating new email addresses is available.
abstract void setIsCustomMessageAvailable(boolean value)
Set to true if the the feature for Custom Message is available
abstract void setIsExpandPageByAvailable(boolean value)
Set to true if the expand pageby option is available.
abstract void setIsRWD(boolean value)
Set to true if the current object is a RW Document.
abstract void setLocationArg(String value)
The name of the location argument.
abstract void setLocationID(String value)
Sets the id of the current location.
abstract void setNewAddressArg(String value)
The name of the newAddress argument.
abstract void setNewAddressValue(String value)
The value of the address list used when creating subscriptions to new addresses
abstract void setObjectName(String value)
Sets the name of the object for which the subscription is created.
abstract void setOpenAddressesEvent(WebEvent event)
Sets the openAddress event.
abstract void setOpenContactsBrowser(boolean openContactsBrowser)
abstract void setOpenContactsBrowserEvent(WebEvent openContactsEditorEvent)
abstract void setProtectZipFile(boolean value)
abstract void setProtectZipFileArg(String arg)
abstract void setSendToInbox(boolean sendToInbox)
abstract void setSendToInboxArg(String arg)
abstract void setSubject(String value)
Sets the text to use as the subject of the email subscriptions sent.
abstract void setSubjectArg(String value)
The Subject's argument name.
abstract void setSubscriptionObjectType(int subscriptionObjectType)
Sets if the current subscription is for a report or for a document.
abstract void setSubscriptionObjectViewType(int subscriptionObjectViewType)
Sets the view mode for the object.
abstract void setZipPassword(String zipPassword)
abstract void setZipPasswordArg(String arg)
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.gui.GuiElement

Public Methods

public abstract String getAddressArg ()

Returns
  • The name of the addressId argument

public abstract String getAddressId ()

This method is deprecated.
replaced by getLocationID()

Returns
  • the value of the current addressId used when creating subscriptions to existing addresses

public abstract String getAddressTypeArg ()

Returns
  • the name for the addressType argument.

public abstract SimpleList getAddresses ()

Returns
  • the current global list of addresses

public abstract SimpleList getAvailableFormats ()

Returns all the available formats for subscription in this system. This could be HTML or EXCEL or PDF or any other such format.

Returns
  • The available formats for subscription.

public abstract SimpleList getAvailableLocations ()

Returns
  • list of available locations for the file subscription.

public abstract int getChangeableMask ()

value from EnumDSSXMLNCSAllowChangeMaskType

public abstract boolean getCompressed ()

Returns true if the current subscription is supposed to be delivered in the compressed(zipped) format.

Returns
  • true if the subscription is to be delivered in the compressed form.

public abstract String getCompressedArg ()

Returns
  • The Compressed argument name.

public abstract String getCompressedFileName ()

Returns
  • The file name.

public abstract String getCompressedFileNameArg ()

Returns
  • The compressed file name arg.

public abstract WebSubscriptionContentFormat getCurrentFormat ()

Returns the current format for this subscription used when creating the subscription. This could be HTML or EXCEL or PDF or any other such format.

Returns
  • The current subscription format.

public abstract String getCustomMessage ()

Returns
  • the message text of new subscriptions created.

public abstract String getCustomMessageArg ()

Returns
  • The Message's argument name.

public abstract String getDeviceArg ()

Returns
  • The deviceId argument name.

public abstract String getDeviceId ()

Returns
  • The current deviceId. This is the device used for new addresses

public abstract SimpleList getDevices ()

Returns
  • the current global list of devices.

public abstract int getExpandPageBy ()

Returns
  • The expand pageby value for the subscription.

public abstract String getExpandPageByArg ()

Returns
  • The expand pageby argument name.

public abstract int getExpandUseSeparateSheets ()

Returns
  • The expand use separate sheets value for the subscription.

public abstract String getExpandUseSeparateSheetsArg ()

Returns
  • The expand use separate sheets argument name.

public abstract String getExpirationDate ()

public abstract String getFileName ()

Returns
  • The file name.

public abstract String getFileNameArg ()

Returns
  • The file name.

public abstract String getFormatArg ()

Returns
  • The Format's argument name.

public abstract String getImageBasePath ()

Returns
  • The name of the image basepath

public abstract int getInitialiIndent ()

Returns
  • The current base indent use by the widget to render its content.

public abstract boolean getIsCreateEmailAvailable ()

Returns
  • true if the feature for creating new email addresses is available.

public abstract boolean getIsCustomMessageAvailable ()

Returns
  • true if the custom message feature is available.

public abstract boolean getIsExpandPageByAvailable ()

Returns
  • true if the expand page by option is available.

public abstract boolean getIsRWD ()

Returns
  • true if the current object is a RW Document.

public abstract String getLocationArg ()

Returns
  • the name for the location argument.

public abstract String getLocationID ()

Returns
  • the current locationID value

public abstract String getNewAddressArg ()

Returns
  • the newAddress argument name

public abstract String getNewAddressValue ()

Returns
  • a comma separated list of addresses used when creating subscriptions to new addresses

public abstract String getObjectName ()

Returns
  • the name of the object for which the subscription is created.

public abstract WebEvent getOpenAddressesEvent ()

Returns
  • the current openAddress event

public abstract String getSubject ()

Returns
  • the subject text of new subscriptions created.

public abstract String getSubjectArg ()

Returns
  • The Subject's argument name.

public abstract int getSubscriptionObjectType ()

Returns if the current subscription is for a report or for a document. The value is specified by the enumeration EnumWebSubscriptionContentTypes

Returns
  • The type of object (report or document) for which we are creating the subscription

public abstract int getSubscriptionObjectViewType ()

Returns the view mode for the object. This can be grid/graph/grid-graph. This applies only to subscriptions to reports. The value is specified by the enumeration EnumWebReportViewMode

Returns
  • The view mode for the object we are subscribing to.

public abstract String getZipPassword ()

public abstract boolean isIncludeDataSet ()

public abstract boolean isIncludeLinkSet ()

public abstract boolean isProtectZipFile ()

public abstract boolean isSendToInboxSet ()

public abstract void renderAddressList (MarkupOutput out, SimpleList addresses, String addressId, String addressArg, String addressTypeArg, String newAddressValue, String newAddressArg, SimpleList devices, String deviceId, String deviceArg)

Renders the list of addresses for the e-mail. 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
addresses the list of addresses
addressId the id of the current address
addressArg the name of the addressId arg
addressTypeArg the name of the addressType arg
newAddressValue the value for the new address list
newAddressArg the name of the new address list argument
devices the list of devices
deviceId the current deviceId
deviceArg the name of the deviceId argument

public abstract void renderCustomMessageField (MarkupOutput out, String message, String argMessage)

Renders a field for the Custom Message which can be sent along with the e-mail sent with the given addresses. 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. This message will be sent along with the report or document which is being subscribed. It would be the first line in the email.

Parameters
out Where to write the widget's output
message The e-mails message text
argMessage the name of the message's argument

public abstract void renderObjectName (MarkupOutput out, String name)

Renders the name of the object for which the subscription is being created. 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
name The name of the object

public abstract void renderSubjectField (MarkupOutput out, String subject, String argSubject)

Renders a field for the Subject's of the e-mail sent with the given addresses. 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
subject The e-mails subjects text
argSubject the name of the subject's argument

public abstract void setAddressArg (String value)

The name of the adressId argument

Parameters
value the new name for the addressId argument

public abstract void setAddressId (String value)

This method is deprecated.
replaced by setLocationID(String)

Sets the value of the current addressId used when creating subscriptions to existing addresses

Parameters
value the new addressId

public abstract void setAddressTypeArg (String value)

The name of the adressType argument. The addressType indicates whether to use an existing addresses or a new address list

Parameters
value the new name for the addressType argument.

public abstract void setAddresses (SimpleList value)

The global list of addresses to use for this subscription

Parameters
value the new global list of addresses

public abstract void setAllowChangeDeliverySettingsArg (String arg)

public abstract void setAllowChangePersonalizationArg (String arg)

public abstract void setAllowUnsubscribeArg (String arg)

public abstract void setAvailableFormats (SimpleList availableFormats)

Sets all the available formats for subscription in this system. This could be HTML or EXCEL or PDF or any other such format.

Parameters
availableFormats The available formats for subscription.

public abstract void setAvailableLocations (SimpleList value)

Sets the list of available locations for the file subscription.

Parameters
value list of available locations for the file subscription.

public abstract void setChangeableMask (int mask)

value from EnumDSSXMLNCSAllowChangeMaskType

public abstract void setCompressed (boolean compressed)

Sets if the current subscription is supposed to be delivered in the compressed(zipped) format.

Parameters
compressed Set to true if the subscription is to be delivered in compressed form.

public abstract void setCompressedArg (String value)

The argument name to for the Compressed value.

Parameters
value The argument name for the Compressed value.

public abstract void setCompressedFileName (String fileName)

Parameters
fileName The compressed file name .

public abstract void setCompressedFileNameArg (String fileNameArg)

Parameters
fileNameArg The compressed file name arg.

public abstract void setCurrentFormat (WebSubscriptionContentFormat currentFormat)

Sets the current format for this subscription used when creating the subscription. This could be HTML or EXCEL or PDF or any other such format.

Parameters
currentFormat The current subscription format.

public abstract void setCustomMessage (String value)

Sets the text to use as the message line of the email subscriptions sent.

Parameters
value the new message text to use

public abstract void setCustomMessageArg (String value)

The Message's argument name.

Parameters
value The new Message's argument name.

public abstract void setDeviceArg (String value)

The name of the deviceId argument.

Parameters
value the new deviceId argument name.

public abstract void setDeviceId (String value)

The current deviceId. This is the device used for new addresses

Parameters
value the new current deviceId

public abstract void setDevices (SimpleList value)

Sets the global list of devices to use for new addresses

Parameters
value the new list of devices.

public abstract void setExpandPageBy (int value)

The value for the expand pageBy.

Parameters
value The new value for the expand pageBy.

public abstract void setExpandPageByArg (String value)

The argument name for the expand pageBy.

Parameters
value The argument name for the expand pageBy.

public abstract void setExpandUseSeparateSheets (int value)

The value for the expand use separate sheets.

Parameters
value The new value for the expand use separate sheets.

public abstract void setExpandUseSeparateSheetsArg (String value)

The argument name for the use separate sheets.

Parameters
value The argument name for the use separate sheets.

public abstract void setExpirationDate (String expirationDate)

public abstract void setExpirationDateArg (String arg)

public abstract void setFileName (String fileName)

Parameters
fileName The file name

public abstract void setFileNameArg (String fileNameArg)

Parameters
fileNameArg The file name arg.

public abstract void setFormatArg (String value)

The Format's argument name.

Parameters
value The argument name for the subscription format.

public abstract void setIServerAsNCSSource ()

used to convey to the widget that IServer is hosting the ncs functionality. If this is not called, widget assumes NCS Engine (old NCS) to be the backend. and disables old functionalities

public abstract void setImageBasePath (String value)

The name of the base path for images

Parameters
value name of the base path for images

public abstract void setIncludeData (boolean includeData)

public abstract void setIncludeDataArg (String arg)

public abstract void setIncludeLink (boolean includeLink)

public abstract void setIncludeLinkArg (String arg)

public abstract void setInitialiIndent (int value)

Defines the initial indent the widget uses to render the content

Parameters
value the new base indent to use

public abstract void setIsCreateEmailAvailable (boolean value)

Set to true if the feature for creating new email addresses is available.

Parameters
value true if the feature for creating new email addresses is available.

public abstract void setIsCustomMessageAvailable (boolean value)

Set to true if the the feature for Custom Message is available

Parameters
value true if the custom message feature is available

public abstract void setIsExpandPageByAvailable (boolean value)

Set to true if the expand pageby option is available.

Parameters
value true if the expand pageby option is available.

public abstract void setIsRWD (boolean value)

Set to true if the current object is a RW Document.

Parameters
value true if the feature for creating new email addresses is available.

public abstract void setLocationArg (String value)

The name of the location argument. A location is an address-device tuple.

Parameters
value the new name for the location argument

public abstract void setLocationID (String value)

Sets the id of the current location. A location is an address-device tuple.

Parameters
value the new value for the current location

public abstract void setNewAddressArg (String value)

The name of the newAddress argument.

Parameters
value the new newAddress argument name

public abstract void setNewAddressValue (String value)

The value of the address list used when creating subscriptions to new addresses

Parameters
value a comma separated list of addresses

public abstract void setObjectName (String value)

Sets the name of the object for which the subscription is created.

Parameters
value the name of the object for which the subscription is created

public abstract void setOpenAddressesEvent (WebEvent event)

Sets the openAddress event. This event is the one used to by the application to open the address list page.

Parameters
event the new openAddress event

public abstract void setOpenContactsBrowser (boolean openContactsBrowser)

public abstract void setOpenContactsBrowserEvent (WebEvent openContactsEditorEvent)

public abstract void setProtectZipFile (boolean value)

public abstract void setProtectZipFileArg (String arg)

public abstract void setSendToInbox (boolean sendToInbox)

public abstract void setSendToInboxArg (String arg)

public abstract void setSubject (String value)

Sets the text to use as the subject of the email subscriptions sent.

Parameters
value the new subject text to use

public abstract void setSubjectArg (String value)

The Subject's argument name.

Parameters
value The new Subject's argument name.

public abstract void setSubscriptionObjectType (int subscriptionObjectType)

Sets if the current subscription is for a report or for a document. The value is specified by the enumeration EnumWebSubscriptionContentTypes

Parameters
subscriptionObjectType The type of object for which we are creating the subscription

public abstract void setSubscriptionObjectViewType (int subscriptionObjectViewType)

Sets the view mode for the object. This can be grid/graph/grid-graph. This applies only to subscriptions to reports. The value is specified by the enumeration EnumWebReportViewMode

Parameters
subscriptionObjectViewType The view mode for the object we are subscribing to.

public abstract void setZipPassword (String zipPassword)

public abstract void setZipPasswordArg (String arg)