Package com.microstrategy.web.objects
Interface WebSubscriptionDeliveryModeEmailProperties
-
- All Superinterfaces:
EnumWebPersistableState
,EnumWebSubscriptionDeliveryMode
,Persistable
,WebSubscriptionDeliveryModeProperties
- All Known Implementing Classes:
WebSubscriptionDeliveryModeEmailPropertiesImpl
public interface WebSubscriptionDeliveryModeEmailProperties extends WebSubscriptionDeliveryModeProperties
Each subscription is associated with a delivery mode. Each delivery mode may define specific properties, which are encapsulated by the relevant
This sub-interface is specifically for email deliveriesWebSubscriptionDeliveryModeProperties
sub-interface.- Since:
- MicroStrategy Web 7.5.1
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
Fields inherited from interface com.microstrategy.web.objects.EnumWebSubscriptionDeliveryMode
SUBSCRIPTION_DELIVERY_MODE_EMAIL, SUBSCRIPTION_DELIVERY_MODE_FILE, SUBSCRIPTION_DELIVERY_MODE_INBOX, SUBSCRIPTION_DELIVERY_MODE_PRINT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getEmailMessage()
java.lang.String
getEmailSubject()
java.lang.String
getFileName()
Returns the name of the file that will be delivered when the subscription is executedjava.lang.String
getSpaceDelimiter()
Returns the space delimiterjava.lang.String
getZipFileName()
Sets the name of the compressed file associated with this subscriptionjava.lang.String
getZipFilePassword()
Returns the password of the compressed file.boolean
isCompressed()
Returns whether the content that is delivered is compressed or notboolean
isDataIncluded()
Returns whether the subscription is configured to include 'data'boolean
isLinkIncluded()
Returns whether the subscription is configured to return a link to the message in the history listboolean
isOverwriteOlderVersion()
Returns whether the current subscription will overwrite earlier versions of the same report or document in the history listboolean
isSendToInbox()
Returns whether the subscription is configured to add the delivered message to history list as well.boolean
isZipFileProtected()
Returns whether the compressed file is password protectedvoid
setCompression(boolean isCompressed)
Sets whether the content that is delivered is compressed or notvoid
setEmailMessage(java.lang.String message)
Sets the email message associated with this subscriptionvoid
setEmailSubject(java.lang.String subject)
Sets the email subject associated with this subscriptionvoid
setFileName(java.lang.String fileName)
Sets the name of the file that will be delivered when the subscription is executedvoid
setHistoryLinkURL(java.lang.String url)
Sets the URL for the link to history list.void
setHistoryLinkWebServer(java.lang.String webserver)
This property stores the default web-server location when the user creates a subscription.void
setIncludeData(boolean value)
Configures whether the subscription should include data in the delivered email.void
setIncludeLink(boolean value)
Configures whether a link to the history list is included in the delivered subscriptionvoid
setOverwriteOlderVersion(boolean overwrite)
Sets whether the subscription will overwrite earlier versions of the same report or document in the history listvoid
setProtectZipFile(boolean isProtected)
Sets whether the compressed file is password protected.void
setSendToInbox(boolean value)
Configures whether the subscription adds the message to history list when it is executedvoid
setSpaceDelimiter(java.lang.String spaceDelimiter)
Sets the space delimitervoid
setZipFileName(java.lang.String fileName)
Returns the name of the compressed file saved in the subscrriptionvoid
setZipFilePassword(java.lang.String p)
Sets the password of the compressed file.-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeProperties
clone, getContactSecurity, getExecutionFlags, getExpiration, getMode, setContactSecurity, setExecutionFlags, setExpiration
-
-
-
-
Method Detail
-
getEmailSubject
java.lang.String getEmailSubject()
- Returns:
- the email subject associated with this subscription
-
setEmailSubject
void setEmailSubject(java.lang.String subject)
Sets the email subject associated with this subscription- Parameters:
subject
- The string that should be used as the subject
-
getEmailMessage
java.lang.String getEmailMessage()
- Returns:
- the email subject associated with this subscription
-
setEmailMessage
void setEmailMessage(java.lang.String message)
Sets the email message associated with this subscription- Parameters:
message
- The string that should be used as the subject
-
getZipFileName
java.lang.String getZipFileName()
Sets the name of the compressed file associated with this subscription- Since:
- MicroStrategy Web 9.0.0
-
setZipFileName
void setZipFileName(java.lang.String fileName)
Returns the name of the compressed file saved in the subscrription- Parameters:
fileName
-- Since:
- MicroStrategy Web 9.0.0
-
getFileName
java.lang.String getFileName()
Returns the name of the file that will be delivered when the subscription is executed- Since:
- MicroStrategy Web 9.0.0
-
setFileName
void setFileName(java.lang.String fileName)
Sets the name of the file that will be delivered when the subscription is executed- Parameters:
fileName
-- Since:
- MicroStrategy Web 9.0.0
-
isCompressed
boolean isCompressed()
Returns whether the content that is delivered is compressed or not- Since:
- MicroStrategy Web 9.0.0
-
setCompression
void setCompression(boolean isCompressed)
Sets whether the content that is delivered is compressed or not- Parameters:
isCompressed
-- Since:
- MicroStrategy Web 9.0.0
-
isLinkIncluded
boolean isLinkIncluded()
Returns whether the subscription is configured to return a link to the message in the history list- Since:
- MicroStrategy Web 9.0.0
-
setIncludeLink
void setIncludeLink(boolean value)
Configures whether a link to the history list is included in the delivered subscription- Parameters:
value
-- Since:
- MicroStrategy Web 9.0.0
-
isDataIncluded
boolean isDataIncluded()
Returns whether the subscription is configured to include 'data'- Since:
- MicroStrategy Web 9.0.0
-
setIncludeData
void setIncludeData(boolean value)
Configures whether the subscription should include data in the delivered email.- Parameters:
value
-- Since:
- MicroStrategy Web 9.0.0
-
isSendToInbox
boolean isSendToInbox()
Returns whether the subscription is configured to add the delivered message to history list as well.- Since:
- MicroStrategy Web 9.0.0
-
setSendToInbox
void setSendToInbox(boolean value)
Configures whether the subscription adds the message to history list when it is executed- Parameters:
value
-- Since:
- MicroStrategy Web 9.0.0
-
setZipFilePassword
void setZipFilePassword(java.lang.String p)
Sets the password of the compressed file.- Parameters:
p
-- Since:
- MicroStrategy Web 9.0.0
-
getZipFilePassword
java.lang.String getZipFilePassword()
Returns the password of the compressed file.- Since:
- MicroStrategy Web 9.0.0
-
setHistoryLinkURL
void setHistoryLinkURL(java.lang.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.- Parameters:
url
-- Since:
- MicroStrategy Web 9.0.0
-
setHistoryLinkWebServer
void setHistoryLinkWebServer(java.lang.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.- Parameters:
webserver
-- Since:
- MicroStrategy Web 9.0.0
-
setProtectZipFile
void setProtectZipFile(boolean isProtected)
Sets whether the compressed file is password protected.- Parameters:
isProtected
-- Since:
- MicroStrategy Web 9.0.0
-
isZipFileProtected
boolean isZipFileProtected()
Returns whether the compressed file is password protected- Since:
- MicroStrategy Web 9.0.0
-
setOverwriteOlderVersion
void setOverwriteOlderVersion(boolean overwrite)
Sets whether the subscription will overwrite earlier versions of the same report or document in the history list- Parameters:
overwrite
-
-
isOverwriteOlderVersion
boolean isOverwriteOlderVersion()
Returns whether the current subscription will overwrite earlier versions of the same report or document in the history list
-
getSpaceDelimiter
java.lang.String getSpaceDelimiter()
Returns the space delimiter
-
setSpaceDelimiter
void setSpaceDelimiter(java.lang.String spaceDelimiter)
Sets the space delimiter
-
-