WebSubscriptionDeliveryModeEmailProperties
implements WebSubscriptionDeliveryModeProperties| com.microstrategy.web.objects.WebSubscriptionDeliveryModeEmailProperties |
 Known Indirect Subclasses
|
Class Overview
Each subscription is associated with a delivery mode. Each delivery mode
may define specific properties, which are encapsulated by the relevant
WebSubscriptionDeliveryModeProperties sub-interface.
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.serialization.EnumWebPersistableState
| |||||||||||
|
From interface
com.microstrategy.web.objects.EnumWebSubscriptionDeliveryMode
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract String | getEmailSubject() | ||||||||||
| abstract String |
getFileName()
Returns the name of the file that will be delivered when the subscription is executed
| ||||||||||
| abstract String |
getSpaceDelimiter()
Returns the space delimiter
| ||||||||||
| abstract String |
getZipFileName()
Sets the name of the compressed file associated with this subscription
| ||||||||||
| abstract String |
getZipFilePassword()
Returns the password of the compressed file.
| ||||||||||
| abstract boolean |
isCompressed()
Returns whether the content that is delivered is compressed or not
| ||||||||||
| abstract boolean |
isDataIncluded()
Returns whether the subscription is configured to include 'data'
| ||||||||||
| abstract boolean |
isLinkIncluded()
Returns whether the subscription is configured to return a link to the message in the history list
| ||||||||||
| abstract boolean |
isOverwriteOlderVersion()
Returns whether the current subscription will overwrite earlier versions of the
same report or document in the history list
| ||||||||||
| abstract boolean |
isSendToInbox()
Returns whether the subscription is configured to add the delivered message to history list as well.
| ||||||||||
| abstract boolean |
isZipFileProtected()
Returns whether the compressed file is password protected
| ||||||||||
| abstract void |
setCompression(boolean isCompressed)
Sets whether the content that is delivered is compressed or not
| ||||||||||
| abstract void |
setEmailSubject(String subject)
Sets the email subject associated with this subscription
| ||||||||||
| abstract void |
setFileName(String fileName)
Sets the name of the file that will be delivered when the subscription is executed
| ||||||||||
| abstract void |
setHistoryLinkURL(String url)
Sets the URL for the link to history list.
| ||||||||||
| abstract void |
setHistoryLinkWebServer(String webserver)
This property stores the default web-server location when the user creates a subscription.
| ||||||||||
| abstract void |
setIncludeData(boolean value)
Configures whether the subscription should include data in the delivered email.
| ||||||||||
| abstract void |
setIncludeLink(boolean value)
Configures whether a link to the history list is included in the delivered subscription
| ||||||||||
| abstract void |
setOverwriteOlderVersion(boolean overwrite)
Sets whether the subscription will overwrite earlier versions of the same report
or document in the history list
| ||||||||||
| abstract void |
setProtectZipFile(boolean isProtected)
Sets whether the compressed file is password protected.
| ||||||||||
| abstract void |
setSendToInbox(boolean value)
Configures whether the subscription adds the message to history list when it is executed
| ||||||||||
| abstract void |
setSpaceDelimiter(String spaceDelimiter)
Sets the space delimiter
| ||||||||||
| abstract void |
setZipFileName(String fileName)
Returns the name of the compressed file saved in the subscrription
| ||||||||||
| abstract void |
setZipFilePassword(String pwd)
Sets the password of the compressed file.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.serialization.Persistable
| |||||||||||
|
From interface
com.microstrategy.web.objects.WebSubscriptionDeliveryModeProperties
| |||||||||||
Public Methods
public abstract String getEmailSubject ()
Returns
- the email subject associated with this subscription
public abstract String getFileName ()
Returns the name of the file that will be delivered when the subscription is executed
public abstract String getSpaceDelimiter ()
Returns the space delimiter
public abstract String getZipFileName ()
Sets the name of the compressed file associated with this subscription
public abstract String getZipFilePassword ()
Returns the password of the compressed file.
public abstract boolean isCompressed ()
Returns whether the content that is delivered is compressed or not
public abstract boolean isDataIncluded ()
Returns whether the subscription is configured to include 'data'
public abstract boolean isLinkIncluded ()
Returns whether the subscription is configured to return a link to the message in the history list
public abstract boolean isOverwriteOlderVersion ()
Returns whether the current subscription will overwrite earlier versions of the same report or document in the history list
public abstract boolean isSendToInbox ()
Returns whether the subscription is configured to add the delivered message to history list as well.
public abstract boolean isZipFileProtected ()
Returns whether the compressed file is password protected
public abstract void setCompression (boolean isCompressed)
Sets whether the content that is delivered is compressed or not
public abstract void setEmailSubject (String subject)
Sets the email subject associated with this subscription
Parameters
| subject | The string that should be used as the subject |
|---|
public abstract void setFileName (String fileName)
Sets the name of the file that will be delivered when the subscription is executed
public abstract void setHistoryLinkURL (String url)
Sets the URL for the link to history list. This URL should contain macros like {&WEBSERVER}, {&SERVERNAME} etc which are replaced at run-time when the subscription or the delivery notification is sent to the recipient.
public abstract void setHistoryLinkWebServer (String webserver)
This property stores the default web-server location when the user creates a subscription. In a normal execution flow, the web-server location is obtained from a property in the DefaultProjectProperties property set. However if this property is not set, then the default web-server location that is saved along with each subscription is used.
public abstract void setIncludeData (boolean value)
Configures whether the subscription should include data in the delivered email.
public abstract void setIncludeLink (boolean value)
Configures whether a link to the history list is included in the delivered subscription
public abstract void setOverwriteOlderVersion (boolean overwrite)
Sets whether the subscription will overwrite earlier versions of the same report or document in the history list
public abstract void setProtectZipFile (boolean isProtected)
Sets whether the compressed file is password protected.
public abstract void setSendToInbox (boolean value)
Configures whether the subscription adds the message to history list when it is executed
public abstract void setSpaceDelimiter (String spaceDelimiter)
Sets the space delimiter
public abstract void setZipFileName (String fileName)
Returns the name of the compressed file saved in the subscrription
public abstract void setZipFilePassword (String pwd)
Sets the password of the compressed file.