public class

SubscriptionFileWidgetImpl

extends AbstractGuiElement
implements DefaultSubscriptionWidget SubscriptionFileWidget SubscriptionWidget
java.lang.Object
   ↳ com.microstrategy.web.app.gui.AbstractGuiElement
     ↳ com.microstrategy.web.app.gui.SubscriptionFileWidgetImpl
Known Direct Subclasses

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.gui.SubscriptionWidget
Fields
protected static String CONTACTS_PANE
protected static String EXISTING_ADDRESSES_PANE
protected static String NEW_ADDRESSES_PANE
protected boolean isDHTML
[Expand]
Inherited Fields
From class com.microstrategy.web.app.gui.AbstractGuiElement
Public Constructors
SubscriptionFileWidgetImpl()
Default no arguments constructor.
Public Methods
String getAddressArg()
String getAddressDivStyle()
Generates the style for showing the address value DIV.
String getAddressId()
String getAddressTypeArg()
SimpleList getAddresses()
String getAllowChangeDeliverySettingsArg()
String getAllowChangePersonalizationArg()
String getAllowUnsubscribeArg()
SimpleList getAvailableFormats()
Returns all the available formats for subscription in this system.
SimpleList getAvailableLocations()
int getChangeableMask()
value from EnumDSSXMLNCSAllowChangeMaskType
String getChangeableMaskArg()
boolean getCompressed()
Returns true if the current subscription is supposed to be delivered in the compressed(zipped) format.
String getCompressedArg()
String getCompressedFileName()
String getCompressedFileNameArg()
WebSubscriptionContentFormat getCurrentFormat()
Returns the current format for this subscription used when creating the subscription.
String getCustomMessage()
String getCustomMessageArg()
String getDeviceArg()
String getDeviceId()
SimpleList getDevices()
int getExpandPageBy()
String getExpandPageByArg()
int getExpandUseSeparateSheets()
String getExpandUseSeparateSheetsArg()
String getExpirationDate()
String getExpirationDateArg()
String getFileName()
String getFileNameArg()
String getFormatArg()
String getImageBasePath()
String getIncludeDataArg()
String getIncludeLinkArg()
int getInitialiIndent()
boolean getIsCreateEmailAvailable()
boolean getIsCustomMessageAvailable()
boolean getIsDeliveryNotificationAvailable()
boolean getIsExpandPageByAvailable()
boolean getIsRWD()
boolean getIsSendNowAvailable()
String getLocationArg()
String getLocationID()
String getNewAddressArg()
String getNewAddressValue()
String getNotificationAddressArg()
String getNotificationAddressId()
String getNotificationAddressTypeArg()
SimpleList getNotificationAddresses()
String getNotificationDeviceArg()
String getNotificationDeviceId()
SimpleList getNotificationDevices()
String getNotificationNewAddressArg()
String getNotificationNewAddressValue()
String getObjectName()
WebEvent getOpenAddressesEvent()
String getProtectZipFileArg()
String getSendNowArg()
String getSendNowDivStyle()
Generates the style for showing the send now value DIV.
String getSendToInboxArg()
String getSubject()
String getSubjectArg()
int getSubscriptionObjectType()
Returns if the current subscription is for a report or for a document.
int getSubscriptionObjectViewType()
Returns the view mode for the object.
String getToolTipforMacro()
Generates the tool tip for showing the list of macros.
String getTriggerArg()
String getTriggerId()
SimpleList getTriggers()
boolean getUseDeliveryNotification()
String getUseDeliveryNotificationArg()
String getZipPassword()
String getZipPasswordArg()
boolean isIncludeDataSet()
boolean isIncludeLinkSet()
boolean isProtectZipFile()
boolean isSendNowSet()
boolean isSendToInboxSet()
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 Subscription.
void renderAvailableLocations(MarkupOutput out, SimpleList locations, String locationID, String argLocation)
Renders the list of available locations for the Subscriptions.
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.
void renderDeliveryFormats(MarkupOutput out, SimpleList availableFormats, WebSubscriptionContentFormat currentFormat, boolean compressed, String formatArg, String compressedArg)
This method is deprecated. No replacement.
void renderDeliveryFormats(MarkupOutput out)
Renders all the available formats that we can subscribe to.
MarkupOutput renderElement()
Renders the element using the global arguments.
void renderFileNameField(MarkupOutput out, String fileName, String argFileName)
Renders a field for the Subject's of the e-mail sent with the given subscriptions.
void renderNotificationAddressList(MarkupOutput out, SimpleList addresses, String addressId, String addressArg, String addressTypeArg, String newAddressValue, String newAddressArg, SimpleList devices, String deviceId, String deviceArg, boolean bUseNotification)
Renders the list of Notification addresses for the Subscription.
void renderObjectName(MarkupOutput out, String name)
Renders the name of the object for which the subscription is being created.
void renderSubjectField(MarkupOutput out, String subject, String argSubject)
Renders a field for the Subject's of the e-mail sent with the given subscriptions.
void renderTriggerList(MarkupOutput out, SimpleList triggers, String triggerId, String argTrigger)
Renders the list of triggers for the Subscriptions.
void renderTriggerList(MarkupOutput out, SimpleList triggers, String triggerId, String argTrigger, boolean selectSendNow)
Renders the list of triggers for the Subscriptions.
void setAddressArg(String value)
The name of the adressId argument
void setAddressId(String value)
Sets the value of the current addressId used when creating subscriptions to existing addresses
void setAddressTypeArg(String value)
The name of the adressType argument.
void setAddresses(SimpleList value)
The global list of addresses to use for this subscription
void setAllowChangeDeliverySettingsArg(String arg)
void setAllowChangePersonalizationArg(String allowChangePersonalizationArg)
void setAllowUnsubscribeArg(String allowUnsubscribeArg)
void setAvailableFormats(SimpleList availableFormats)
Sets all the available formats for subscription in this system.
void setAvailableLocations(SimpleList value)
Sets the list of available locations for the file subscription.
void setChangeableMask(int changeableMask)
value from EnumDSSXMLNCSAllowChangeMaskType
void setCompressed(boolean compressed)
Sets if the current subscription is supposed to be delivered in the compressed(zipped) format.
void setCompressedArg(String value)
The argument name to for the Compressed value.
void setCompressedFileName(String compressedFileName)
void setCompressedFileNameArg(String compressedFileNameArg)
void setCurrentFormat(WebSubscriptionContentFormat currentFormat)
Sets the current format for this subscription used when creating the subscription.
void setCustomMessage(String value)
Sets the text to use as the message line of the email subscriptions sent.
void setCustomMessageArg(String value)
The Message's argument name.
void setDeviceArg(String value)
The name of the deviceId argument.
void setDeviceId(String value)
The current deviceId.
void setDevices(SimpleList value)
Sets the global list of devices to use for new addresses
void setExpandPageBy(int value)
The value for the expand pageBy.
void setExpandPageByArg(String value)
The argument name for the expand pageBy.
void setExpandUseSeparateSheets(int value)
The value for the expand use separate sheets.
void setExpandUseSeparateSheetsArg(String value)
The argument name for the expand use separate sheets.
void setExpirationDate(String expirationDate)
void setExpirationDateArg(String expirationDateArg)
void setFileName(String value)
Sets the name of the file to which the export will be sent.
void setFileNameArg(String value)
The FileName argument name.
void setFormatArg(String value)
The Format's argument name.
void setIServerAsNCSSource()
used to convey to the widget that IServer is hosting the ncs functionality.
void setImageBasePath(String value)
The name of the base path for images
void setIncludeData(boolean includeData)
void setIncludeDataArg(String includeDataArg)
void setIncludeLink(boolean includeLink)
void setIncludeLinkArg(String includeLinkArg)
void setInitialiIndent(int value)
Defines the initial indent the widget uses to render the content
void setIsBulkExport(boolean value)
Set to true if the current object is a bulk export report.
void setIsCreateEmailAvailable(boolean value)
Set to true if the feature for creating new email addresses is available.
void setIsCustomMessageAvailable(boolean value)
Set to true if the the feature for Custom Message is available
void setIsDeliveryNotificationAvailable(boolean value)
Set to true if delivery notification is available.
void setIsExpandPageByAvailable(boolean value)
Set to true if the expand pageby option is available.
void setIsRWD(boolean value)
Indicated whether it is an RWD or not.
void setIsSendNowAvailable(boolean value)
Set to true if the the feature for Send Now is available
void setLocationArg(String value)
The name of the location argument.
void setLocationID(String value)
Sets the id of the current location.
void setNewAddressArg(String value)
The name of the newAddress argument.
void setNewAddressValue(String value)
The value of the address list used when creating subscriptions to new addresses
void setNotificationAddressArg(String value)
The name of the notification adressId argument
void setNotificationAddressId(String value)
Sets the value of the current notification addressId used when creating subscriptions to existing addresses
void setNotificationAddressTypeArg(String value)
The name of the notification adressType argument.
void setNotificationAddresses(SimpleList value)
The global list of notification addresses to use for this subscription
void setNotificationDeviceArg(String value)
The name of the notification deviceId argument.
void setNotificationDeviceId(String value)
The current notification deviceId.
void setNotificationDevices(SimpleList value)
Sets the global list of notification devices to use for new addresses
void setNotificationNewAddressArg(String value)
The name of the notification newAddress argument.
void setNotificationNewAddressValue(String value)
The value of the notification address list used when creating subscriptions to new addresses
void setObjectName(String value)
Sets the name of the object for which the subscription is created.
void setOpenAddressesEvent(WebEvent event)
Sets the openAddress event.
void setOpenContactsBrowser(boolean openContactsBrowser)
void setOpenContactsBrowserEvent(WebEvent openContactsEditorEvent)
void setProtectZipFile(boolean protectZipFile)
void setProtectZipFileArg(String protectZipFileArg)
void setSendNow(boolean value)
Indicated whether to send a preview of the subscription now.
void setSendNowArg(String value)
The sendNow's argument name.
void setSendToInbox(boolean sendToInbox)
void setSendToInboxArg(String sendToInboxArg)
void setSubject(String value)
Sets the text to use as the subject of the email subscriptions sent.
void setSubjectArg(String value)
The Subject's argument name.
void setSubscriptionObjectType(int subscriptionObjectType)
Sets if the current subscription is for a report or for a document.
void setSubscriptionObjectViewType(int subscriptionObjectViewType)
Sets the view mode for the object.
void setTriggerArg(String value)
The name of the triggerId argument
void setTriggerId(String value)
Sets the id of the current trigger
void setTriggers(SimpleList value)
Sets the id of the current trigger
void setUseDeliveryNotification(boolean value)
Set to true if delivery notification is currently used.
void setUseDeliveryNotificationArg(String value)
The name of the useDeliveryNotification argument.
void setZipPassword(String zipPassword)
void setZipPasswordArg(String zipPasswordArg)
Protected Methods
GGCalendar renderCalendar(MarkupOutput out)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.gui.AbstractGuiElement
From class java.lang.Object
From interface com.microstrategy.web.app.gui.DefaultSubscriptionWidget
From interface com.microstrategy.web.app.gui.GuiElement
From interface com.microstrategy.web.app.gui.SubscriptionFileWidget
From interface com.microstrategy.web.app.gui.SubscriptionWidget

Fields

protected static String CONTACTS_PANE

protected static String EXISTING_ADDRESSES_PANE

protected static String NEW_ADDRESSES_PANE

protected boolean isDHTML

Public Constructors

public SubscriptionFileWidgetImpl ()

Default no arguments constructor. Initialize the widget with default values.

Public Methods

public String getAddressArg ()

Returns
  • The name of the addressId argument

public String getAddressDivStyle ()

Generates the style for showing the address value DIV.

Returns
  • The style for showing the address value DIV.

public String getAddressId ()

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

public String getAddressTypeArg ()

Returns
  • the name for the addressType argument.

public SimpleList getAddresses ()

Returns
  • the current global list of addresses

public String getAllowChangeDeliverySettingsArg ()

public String getAllowChangePersonalizationArg ()

public String getAllowUnsubscribeArg ()

public 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 SimpleList getAvailableLocations ()

public int getChangeableMask ()

value from EnumDSSXMLNCSAllowChangeMaskType

public String getChangeableMaskArg ()

public 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 String getCompressedArg ()

Returns
  • The Compressed argument name.

public String getCompressedFileName ()

public String getCompressedFileNameArg ()

public 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 String getCustomMessage ()

Returns
  • the message text of new subscriptions created.

public String getCustomMessageArg ()

Returns
  • The Message's argument name.

public String getDeviceArg ()

Returns
  • The deviceId argument name.

public String getDeviceId ()

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

public SimpleList getDevices ()

Returns
  • the current global list of devices.

public int getExpandPageBy ()

Returns
  • The expand pageby value for the subscription.

public String getExpandPageByArg ()

Returns
  • The expand pageby argument name.

public int getExpandUseSeparateSheets ()

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

public String getExpandUseSeparateSheetsArg ()

Returns
  • The expand use separate sheets argument name.

public String getExpirationDate ()

public String getExpirationDateArg ()

public String getFileName ()

Returns
  • the name of the file to which the export will be sent.

public String getFileNameArg ()

Returns
  • The FileName argument name.

public String getFormatArg ()

Returns
  • The Format's argument name.

public String getImageBasePath ()

Returns
  • The name of the image basepath

public String getIncludeDataArg ()

public String getIncludeLinkArg ()

public int getInitialiIndent ()

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

public boolean getIsCreateEmailAvailable ()

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

public boolean getIsCustomMessageAvailable ()

Returns
  • true if the custom message feature is available.

public boolean getIsDeliveryNotificationAvailable ()

Returns
  • true if delivery notification is available.

public boolean getIsExpandPageByAvailable ()

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

public boolean getIsRWD ()

Returns
  • true if it is an RWD.

public boolean getIsSendNowAvailable ()

Returns
  • true if the send now feature is available.

public String getLocationArg ()

public String getLocationID ()

public String getNewAddressArg ()

Returns
  • the newAddress argument name

public String getNewAddressValue ()

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

public String getNotificationAddressArg ()

Returns
  • The name of the notification addressId argument

public String getNotificationAddressId ()

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

public String getNotificationAddressTypeArg ()

Returns
  • the name for the notification addressType argument.

public SimpleList getNotificationAddresses ()

Returns
  • the current global list of notification addresses

public String getNotificationDeviceArg ()

Returns
  • The notification deviceId argument name.

public String getNotificationDeviceId ()

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

public SimpleList getNotificationDevices ()

Returns
  • the current global list of Notification devices.

public String getNotificationNewAddressArg ()

Returns
  • the notification newAddress argument name

public String getNotificationNewAddressValue ()

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

public String getObjectName ()

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

public WebEvent getOpenAddressesEvent ()

Returns
  • the current openAddress event

public String getProtectZipFileArg ()

public String getSendNowArg ()

Returns
  • The sendNow argument name.

public String getSendNowDivStyle ()

Generates the style for showing the send now value DIV.

Returns
  • The style for showing the address value DIV.

public String getSendToInboxArg ()

public String getSubject ()

Returns
  • the subject text of new subscriptions created.

public String getSubjectArg ()

Returns
  • The Subject's argument name.

public int getSubscriptionObjectType ()

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

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

public 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 String getToolTipforMacro ()

Generates the tool tip for showing the list of macros.

Returns
  • The tool tip showing the list of macros.

public String getTriggerArg ()

Returns
  • The name of the triggerId argument

public String getTriggerId ()

Returns
  • the current triggerId value

public SimpleList getTriggers ()

Returns
  • the current triggerId value

public boolean getUseDeliveryNotification ()

Returns
  • true if delivery notification is currently used.

public String getUseDeliveryNotificationArg ()

Returns
  • The useDeliveryNotification argument name.

public String getZipPassword ()

public String getZipPasswordArg ()

public boolean isIncludeDataSet ()

public boolean isIncludeLinkSet ()

public boolean isProtectZipFile ()

public boolean isSendNowSet ()

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

public boolean isSendToInboxSet ()

public 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 Subscription. 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 void renderAvailableLocations (MarkupOutput out, SimpleList locations, String locationID, String argLocation)

Renders the list of available locations 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
locations the list of locations
locationID the current location ID
argLocation the name of the location ID argument

public 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 void renderDeliveryFormats (MarkupOutput out, SimpleList availableFormats, WebSubscriptionContentFormat currentFormat, boolean compressed, String formatArg, String compressedArg)

This method is deprecated.
No replacement.

Renders all the available formats that we can subscribe to. This could be HTML or EXCEL or PDF or any other format supported by the system. It also renders a check box which indicates if we want to compress the contents of the subscription for delivery. 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.

Parameters
out Where to write the widget's output
availableFormats All the available delivery formats
currentFormat The current delivery format
compressed Indicates if the contents of the subscription need to be compressed (zipped)
formatArg The name of the format's argument
compressedArg The name of the compression argument

public void renderDeliveryFormats (MarkupOutput out)

Renders all the available formats that we can subscribe to. This could be HTML or EXCEL or PDF or any other format supported by the system. It also renders a check box which indicates if we want to compress the contents of the subscription for delivery. 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.

Parameters
out Where to write the widget's output

public MarkupOutput renderElement ()

Renders the element using the global arguments.

Returns
  • a MarkupOutput with the Subscription Widget.

public void renderFileNameField (MarkupOutput out, String fileName, String argFileName)

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

public void renderNotificationAddressList (MarkupOutput out, SimpleList addresses, String addressId, String addressArg, String addressTypeArg, String newAddressValue, String newAddressArg, SimpleList devices, String deviceId, String deviceArg, boolean bUseNotification)

Renders the list of Notification addresses for the Subscription. 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
bUseNotification the boolean argument to denote whether the subscription uses notification

public 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 void renderSubjectField (MarkupOutput out, String subject, String argSubject)

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

public 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 void renderTriggerList (MarkupOutput out, SimpleList triggers, String triggerId, String argTrigger, boolean selectSendNow)

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
selectSendNow boolean to indicate if the send now schedule is to be pre selected in case of creating a new subscrtiption (Does not apply for edit case)

public void setAddressArg (String value)

The name of the adressId argument

Parameters
value the new name for the addressId argument

public void setAddressId (String value)

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

Parameters
value the new addressId

public 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 void setAddresses (SimpleList value)

The global list of addresses to use for this subscription

Parameters
value the new global list of addresses

public void setAllowChangeDeliverySettingsArg (String arg)

public void setAllowChangePersonalizationArg (String allowChangePersonalizationArg)

public void setAllowUnsubscribeArg (String allowUnsubscribeArg)

public 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 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 void setChangeableMask (int changeableMask)

value from EnumDSSXMLNCSAllowChangeMaskType

public 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 void setCompressedArg (String value)

The argument name to for the Compressed value.

Parameters
value The argument name for the Compressed value.

public void setCompressedFileName (String compressedFileName)

public void setCompressedFileNameArg (String compressedFileNameArg)

public 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 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 void setCustomMessageArg (String value)

The Message's argument name.

Parameters
value The new Message's argument name.

public void setDeviceArg (String value)

The name of the deviceId argument.

Parameters
value the new deviceId argument name.

public void setDeviceId (String value)

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

Parameters
value the new current deviceId

public void setDevices (SimpleList value)

Sets the global list of devices to use for new addresses

Parameters
value the new list of devices.

public void setExpandPageBy (int value)

The value for the expand pageBy.

Parameters
value The new value for the expand pageBy.

public void setExpandPageByArg (String value)

The argument name for the expand pageBy.

Parameters
value The argument name for the Compressed value.

public void setExpandUseSeparateSheets (int value)

The value for the expand use separate sheets.

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

public void setExpandUseSeparateSheetsArg (String value)

The argument name for the expand use separate sheets.

Parameters
value The argument name for the Compressed value.

public void setExpirationDate (String expirationDate)

public void setExpirationDateArg (String expirationDateArg)

public void setFileName (String value)

Sets the name of the file to which the export will be sent.

Parameters
value the name of the file to which the export will be sent.

public void setFileNameArg (String value)

The FileName argument name.

Parameters
value The FileName argument name.

public void setFormatArg (String value)

The Format's argument name.

Parameters
value The argument name for the subscription format.

public 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 void setImageBasePath (String value)

The name of the base path for images

Parameters
value name of the base path for images

public void setIncludeData (boolean includeData)

public void setIncludeDataArg (String includeDataArg)

public void setIncludeLink (boolean includeLink)

public void setIncludeLinkArg (String includeLinkArg)

public void setInitialiIndent (int value)

Defines the initial indent the widget uses to render the content

Parameters
value the new base indent to use

public void setIsBulkExport (boolean value)

Set to true if the current object is a bulk export report.

Parameters
value true current object is a bulk export report.

public 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 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 void setIsDeliveryNotificationAvailable (boolean value)

Set to true if delivery notification is available.

Parameters
value true if delivery notification is available.

public 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 void setIsRWD (boolean value)

Indicated whether it is an RWD or not.

Parameters
value true if it is an RWD.

public 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 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 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 void setNewAddressArg (String value)

The name of the newAddress argument.

Parameters
value the new newAddress argument name

public 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 void setNotificationAddressArg (String value)

The name of the notification adressId argument

Parameters
value the new name for the notification addressId argument

public void setNotificationAddressId (String value)

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

Parameters
value the new notification addressId

public void setNotificationAddressTypeArg (String value)

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

Parameters
value the new name for the notification addressType argument.

public void setNotificationAddresses (SimpleList value)

The global list of notification addresses to use for this subscription

Parameters
value the new global list of notification addresses

public void setNotificationDeviceArg (String value)

The name of the notification deviceId argument.

Parameters
value the new notification deviceId argument name.

public void setNotificationDeviceId (String value)

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

Parameters
value the new current notification deviceId

public void setNotificationDevices (SimpleList value)

Sets the global list of notification devices to use for new addresses

Parameters
value the new list of notification devices.

public void setNotificationNewAddressArg (String value)

The name of the notification newAddress argument.

Parameters
value the new notification newAddress argument name

public void setNotificationNewAddressValue (String value)

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

Parameters
value a comma separated list of notification addresses

public 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 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 void setOpenContactsBrowser (boolean openContactsBrowser)

public void setOpenContactsBrowserEvent (WebEvent openContactsEditorEvent)

public void setProtectZipFile (boolean protectZipFile)

public void setProtectZipFileArg (String protectZipFileArg)

public 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 void setSendNowArg (String value)

The sendNow's argument name.

Parameters
value The new sendNow argument name.

public void setSendToInbox (boolean sendToInbox)

public void setSendToInboxArg (String sendToInboxArg)

public 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 void setSubjectArg (String value)

The Subject's argument name.

Parameters
value The new Subject's argument name.

public void setSubscriptionObjectType (int subscriptionObjectType)

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

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

public 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 void setTriggerArg (String value)

The name of the triggerId argument

Parameters
value the new name for the triggerId argument

public void setTriggerId (String value)

Sets the id of the current trigger

Parameters
value the new value for the current trigger

public void setTriggers (SimpleList value)

Sets the id of the current trigger

Parameters
value the new value for the current trigger

public void setUseDeliveryNotification (boolean value)

Set to true if delivery notification is currently used.

Parameters
value true if delivery notification is currently used.

public void setUseDeliveryNotificationArg (String value)

The name of the useDeliveryNotification argument.

Parameters
value the new useDeliveryNotification argument name.

public void setZipPassword (String zipPassword)

public void setZipPasswordArg (String zipPasswordArg)

Protected Methods

protected GGCalendar renderCalendar (MarkupOutput out)