Package com.microstrategy.web.objects
Class WebSubscriptionDeliveryModeEmailPropertiesImpl
- java.lang.Object
-
- com.microstrategy.web.objects.WebSubscriptionDeliveryModeEmailPropertiesImpl
-
- All Implemented Interfaces:
EnumWebPersistableState
,Persistable
,EnumWebSubscriptionDeliveryMode
,WebSubscriptionDeliveryModeEmailProperties
,WebSubscriptionDeliveryModeProperties
public class WebSubscriptionDeliveryModeEmailPropertiesImpl extends java.lang.Object implements WebSubscriptionDeliveryModeEmailProperties
- 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
-
-
Constructor Summary
Constructors Constructor Description WebSubscriptionDeliveryModeEmailPropertiesImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
java.lang.String
getContactSecurity()
Returns whether use Contact Security for each contact group memberjava.lang.String
getEmailMessage()
java.lang.String
getEmailSubject()
int
getExecutionFlags()
Gets the execution flags that have been set to be used when the history list subscription is run.java.lang.String
getExpiration()
Returns the expiration date of the subscriptionjava.lang.String
getFileName()
Returns the name of the file that will be delivered when the subscription is executedint
getMode()
java.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 protectedboolean
restoreState(SAXSupport parser, java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attrs)
Restores a component from an embedded XML during a SAX parsing.boolean
restoreState(java.lang.String state)
Restores a component based on its saved state.java.lang.String
saveState()
Returns ajava.lang.String
representation of a component.java.lang.String
saveState(int howMuchState)
Returns ajava.lang.String
representation of a component.void
saveState(java.lang.StringBuffer buf, int howMuchState)
Saves and stores a component's state into aStringBuffer
.void
saveState(java.lang.StringBuffer buf, int howMuchState, int stateFlag)
Saves and stores a component's state into aStringBuffer
.void
setCompression(boolean isCompressed)
Sets whether the content that is delivered is compressed or notvoid
setContactSecurity(java.lang.String useContSec)
Sets whether use Contact Security for each contact group membervoid
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
setExecutionFlags(int execFlags)
Sets the execution flags to be used when the history list subscription is run.void
setExpiration(java.lang.String expiration)
Sets the expiration date of the 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.
-
-
-
Method Detail
-
clone
public java.lang.Object clone()
- Specified by:
clone
in interfaceWebSubscriptionDeliveryModeProperties
- Overrides:
clone
in classjava.lang.Object
-
getEmailSubject
public java.lang.String getEmailSubject()
- Specified by:
getEmailSubject
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Returns:
- the email subject associated with this subscription
-
setEmailSubject
public void setEmailSubject(java.lang.String subject)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Sets the email subject associated with this subscription- Specified by:
setEmailSubject
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Parameters:
subject
- The string that should be used as the subject
-
getEmailMessage
public java.lang.String getEmailMessage()
- Specified by:
getEmailMessage
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Returns:
- the email subject associated with this subscription
-
setEmailMessage
public void setEmailMessage(java.lang.String message)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Sets the email message associated with this subscription- Specified by:
setEmailMessage
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Parameters:
message
- The string that should be used as the subject
-
getMode
public int getMode()
- Specified by:
getMode
in interfaceWebSubscriptionDeliveryModeProperties
- Returns:
- the associated enumeration from
EnumWebSubscriptionDeliveryMode
-
saveState
public java.lang.String saveState(int howMuchState)
Description copied from interface:Persistable
Returns ajava.lang.String
representation of a component. The returned state should be HTML friendly. This method call is equivalent to callsaveState(new StringBuffer(), howMuchState)
.- Specified by:
saveState
in interfacePersistable
- Parameters:
howMuchState
- how much state information to save (EnumWebPersistableState
).- Returns:
- the serialized state of a component.
-
saveState
public java.lang.String saveState()
Description copied from interface:Persistable
Returns ajava.lang.String
representation of a component. The returned state should be HTML friendly. This method call is equivalent to callsaveState(EnumWebPersistableState.TYPICAL_STATE_INFO)
.- Specified by:
saveState
in interfacePersistable
- Returns:
- the serialized state of a component.
-
restoreState
public boolean restoreState(java.lang.String state)
Description copied from interface:Persistable
Restores a component based on its saved state.- Specified by:
restoreState
in interfacePersistable
- Parameters:
state
- the state of a component- Returns:
- true if restoration succeeds.
-
saveState
public void saveState(java.lang.StringBuffer buf, int howMuchState, int stateFlag) throws java.lang.UnsupportedOperationException
Description copied from interface:Persistable
Saves and stores a component's state into aStringBuffer
. The returned state should be HTML friendly.There are generally two formats of the saved state: flat state and XML representation. The minimum state is saved in flat state format, while the typical and maximum states are saved in XML string representation.
- Specified by:
saveState
in interfacePersistable
- Parameters:
buf
- a StringBuffer to store the saved state.howMuchState
- how much state information to save (EnumWebPersistableState
).stateFlag
- bit-wise flag to indicate additional information about the state (EnumWebStateFlags
).- Throws:
java.lang.UnsupportedOperationException
- thrown if the component does not support this method, or does not support certainhowMuchState
level.- Since:
- MicroStrategy Web 9.0.0
-
saveState
public void saveState(java.lang.StringBuffer buf, int howMuchState) throws java.lang.UnsupportedOperationException
Description copied from interface:Persistable
Saves and stores a component's state into aStringBuffer
. The returned state should be HTML friendly.There are generally two formats of the saved state: flat state and XML representation. The minimum state is saved in flat state format, while the typical and maximum states are saved in XML string representation.
- Specified by:
saveState
in interfacePersistable
- Parameters:
buf
- a StringBuffer to store the saved state.howMuchState
- how much state information to save (EnumWebPersistableState
).- Throws:
java.lang.UnsupportedOperationException
- thrown if the component does not support this method, or does not support certainhowMuchState
level.
-
restoreState
public boolean restoreState(SAXSupport parser, java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attrs)
Description copied from interface:Persistable
Restores a component from an embedded XML during a SAX parsing.- Specified by:
restoreState
in interfacePersistable
- Parameters:
parser
- a SAX parser processing the XML representation of a stateuri
- The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performedlocalName
- The local name (without prefix), or the empty string if Namespace processing is not being performedqName
- The qualified name (with prefix), or the empty string if qualified names are not availableattrs
- The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object- Returns:
true
to indicate a successful restoration. Otherwise,false
will be returned.
-
isLinkIncluded
public boolean isLinkIncluded()
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Returns whether the subscription is configured to return a link to the message in the history list- Specified by:
isLinkIncluded
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setIncludeLink
public void setIncludeLink(boolean value)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Configures whether a link to the history list is included in the delivered subscription- Specified by:
setIncludeLink
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
isDataIncluded
public boolean isDataIncluded()
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Returns whether the subscription is configured to include 'data'- Specified by:
isDataIncluded
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setIncludeData
public void setIncludeData(boolean value)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Configures whether the subscription should include data in the delivered email.- Specified by:
setIncludeData
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
isSendToInbox
public boolean isSendToInbox()
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Returns whether the subscription is configured to add the delivered message to history list as well.- Specified by:
isSendToInbox
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setSendToInbox
public void setSendToInbox(boolean value)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Configures whether the subscription adds the message to history list when it is executed- Specified by:
setSendToInbox
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
getExpiration
public java.lang.String getExpiration()
Description copied from interface:WebSubscriptionDeliveryModeProperties
Returns the expiration date of the subscription- Specified by:
getExpiration
in interfaceWebSubscriptionDeliveryModeProperties
- Since:
- MicroStrategy Web 9.0.0
-
getZipFileName
public java.lang.String getZipFileName()
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Sets the name of the compressed file associated with this subscription- Specified by:
getZipFileName
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setZipFileName
public void setZipFileName(java.lang.String fileName)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Returns the name of the compressed file saved in the subscrription- Specified by:
setZipFileName
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
getFileName
public java.lang.String getFileName()
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Returns the name of the file that will be delivered when the subscription is executed- Specified by:
getFileName
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setFileName
public void setFileName(java.lang.String fileName)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Sets the name of the file that will be delivered when the subscription is executed- Specified by:
setFileName
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setExpiration
public void setExpiration(java.lang.String expiration)
Description copied from interface:WebSubscriptionDeliveryModeProperties
Sets the expiration date of the subscription- Specified by:
setExpiration
in interfaceWebSubscriptionDeliveryModeProperties
- Since:
- MicroStrategy Web 9.0.0
-
isCompressed
public boolean isCompressed()
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Returns whether the content that is delivered is compressed or not- Specified by:
isCompressed
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setCompression
public void setCompression(boolean isCompressed)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Sets whether the content that is delivered is compressed or not- Specified by:
setCompression
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setZipFilePassword
public void setZipFilePassword(java.lang.String p)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Sets the password of the compressed file.- Specified by:
setZipFilePassword
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
getZipFilePassword
public java.lang.String getZipFilePassword()
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Returns the password of the compressed file.- Specified by:
getZipFilePassword
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setHistoryLinkURL
public void setHistoryLinkURL(java.lang.String url)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
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.- Specified by:
setHistoryLinkURL
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setHistoryLinkWebServer
public void setHistoryLinkWebServer(java.lang.String webserver)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
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.- Specified by:
setHistoryLinkWebServer
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
getExecutionFlags
public int getExecutionFlags()
Description copied from interface:WebSubscriptionDeliveryModeProperties
Gets the execution flags that have been set to be used when the history list subscription is run. Please seeWebSubscriptionDeliveryModeProperties.setExecutionFlags(int)
for mode details.- Specified by:
getExecutionFlags
in interfaceWebSubscriptionDeliveryModeProperties
- Returns:
- Execution flags
- Since:
- MicroStrategy Web 9.0.0
-
setExecutionFlags
public void setExecutionFlags(int execFlags)
Description copied from interface:WebSubscriptionDeliveryModeProperties
Sets the execution flags to be used when the history list subscription is run. If the subscription is to a report object, then use the execution flags fromEnumDSSXMLExecutionFlags
. If the subscription is to a document, then use the execution flags fromEnumDSSXMLDocExecutionFlags
.- Specified by:
setExecutionFlags
in interfaceWebSubscriptionDeliveryModeProperties
- Since:
- MicroStrategy Web 9.0.0
-
isZipFileProtected
public boolean isZipFileProtected()
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Returns whether the compressed file is password protected- Specified by:
isZipFileProtected
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
setProtectZipFile
public void setProtectZipFile(boolean isProtected)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Sets whether the compressed file is password protected.- Specified by:
setProtectZipFile
in interfaceWebSubscriptionDeliveryModeEmailProperties
- Since:
- MicroStrategy Web 9.0.0
-
isOverwriteOlderVersion
public boolean isOverwriteOlderVersion()
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Returns whether the current subscription will overwrite earlier versions of the same report or document in the history list- Specified by:
isOverwriteOlderVersion
in interfaceWebSubscriptionDeliveryModeEmailProperties
-
setOverwriteOlderVersion
public void setOverwriteOlderVersion(boolean overwrite)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Sets whether the subscription will overwrite earlier versions of the same report or document in the history list- Specified by:
setOverwriteOlderVersion
in interfaceWebSubscriptionDeliveryModeEmailProperties
-
getContactSecurity
public java.lang.String getContactSecurity()
Description copied from interface:WebSubscriptionDeliveryModeProperties
Returns whether use Contact Security for each contact group member- Specified by:
getContactSecurity
in interfaceWebSubscriptionDeliveryModeProperties
-
setContactSecurity
public void setContactSecurity(java.lang.String useContSec)
Description copied from interface:WebSubscriptionDeliveryModeProperties
Sets whether use Contact Security for each contact group member- Specified by:
setContactSecurity
in interfaceWebSubscriptionDeliveryModeProperties
-
getSpaceDelimiter
public java.lang.String getSpaceDelimiter()
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Returns the space delimiter- Specified by:
getSpaceDelimiter
in interfaceWebSubscriptionDeliveryModeEmailProperties
-
setSpaceDelimiter
public void setSpaceDelimiter(java.lang.String spaceDelimiter)
Description copied from interface:WebSubscriptionDeliveryModeEmailProperties
Sets the space delimiter- Specified by:
setSpaceDelimiter
in interfaceWebSubscriptionDeliveryModeEmailProperties
-
-