public class

WebSubscriptionDeliveryModeEmailPropertiesImpl

extends Object
implements WebSubscriptionDeliveryModeEmailProperties
java.lang.Object
   ↳ com.microstrategy.web.objects.WebSubscriptionDeliveryModeEmailPropertiesImpl

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.EnumWebSubscriptionDeliveryMode
Public Constructors
WebSubscriptionDeliveryModeEmailPropertiesImpl()
Public Methods
Object clone()
String getContactSecurity()
Returns whether use Contact Security for each contact group member
String getEmailSubject()
int getExecutionFlags()
Gets the execution flags that have been set to be used when the history list subscription is run.
String getExpiration()
Returns the expiration date of the subscription
String getFileName()
Returns the name of the file that will be delivered when the subscription is executed
int getMode()
String getSpaceDelimiter()
Returns the space delimiter
String getZipFileName()
Sets the name of the compressed file associated with this subscription
String getZipFilePassword()
Returns the password of the compressed file.
boolean isCompressed()
Returns whether the content that is delivered is compressed or not
boolean 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 list
boolean isOverwriteOlderVersion()
Returns whether the current subscription will overwrite earlier versions of the same report or document in the history list
boolean 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 protected
boolean restoreState(String state)
Restores a component based on its saved state.
boolean restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs)
Restores a component from an embedded XML during a SAX parsing.
String saveState()
Returns a java.lang.String representaion of a component.
void saveState(StringBuffer buf, int howMuchState)
Saves and stores a component's state into a StringBuffer.
String saveState(int howMuchState)
Returns a java.lang.String representaion of a component.
void saveState(StringBuffer buf, int howMuchState, int stateFlag)
Saves and stores a component's state into a StringBuffer.
void setCompression(boolean isCompressed)
Sets whether the content that is delivered is compressed or not
void setContactSecurity(String useContSec)
Sets whether use Contact Security for each contact group member
void setEmailSubject(String subject)
Sets the email subject associated with this subscription
void setExecutionFlags(int execFlags)
Sets the execution flags to be used when the history list subscription is run.
void setExpiration(String expiration)
Sets the expiration date of the subscription
void setFileName(String fileName)
Sets the name of the file that will be delivered when the subscription is executed
void setHistoryLinkURL(String url)
Sets the URL for the link to history list.
void setHistoryLinkWebServer(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 subscription
void setOverwriteOlderVersion(boolean overwrite)
Sets whether the subscription will overwrite earlier versions of the same report or document in the history list
void 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 executed
void setSpaceDelimiter(String spaceDelimiter)
Sets the space delimiter
void setZipFileName(String fileName)
Returns the name of the compressed file saved in the subscrription
void setZipFilePassword(String pwd)
Sets the password of the compressed file.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeEmailProperties
From interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeProperties

Public Constructors

public WebSubscriptionDeliveryModeEmailPropertiesImpl ()

Public Methods

public Object clone ()

public String getContactSecurity ()

Returns whether use Contact Security for each contact group member

public String getEmailSubject ()

public int getExecutionFlags ()

Gets the execution flags that have been set to be used when the history list subscription is run. Please see setExecutionFlags(int) for mode details.

Returns
  • Execution flags

public String getExpiration ()

Returns the expiration date of the subscription

public String getFileName ()

Returns the name of the file that will be delivered when the subscription is executed

public int getMode ()

public String getSpaceDelimiter ()

Returns the space delimiter

public String getZipFileName ()

Sets the name of the compressed file associated with this subscription

public String getZipFilePassword ()

Returns the password of the compressed file.

public boolean isCompressed ()

Returns whether the content that is delivered is compressed or not

public boolean isDataIncluded ()

Returns whether the subscription is configured to include 'data'

public boolean isLinkIncluded ()

Returns whether the subscription is configured to return a link to the message in the history list

public boolean isOverwriteOlderVersion ()

Returns whether the current subscription will overwrite earlier versions of the same report or document in the history list

public boolean isSendToInbox ()

Returns whether the subscription is configured to add the delivered message to history list as well.

public boolean isZipFileProtected ()

Returns whether the compressed file is password protected

public boolean restoreState (String state)

Restores a component based on its saved state.

Parameters
state the state of a component
Returns
  • true if restoration succeeds.

public boolean restoreState (SAXSupport parser, String uri, String localName, String qName, Attributes attrs)

Restores a component from an embedded XML during a SAX parsing.

Parameters
parser a SAX parser processing the XML representation of a state
uri The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed
localName The local name (without prefix), or the empty string if Namespace processing is not being performed
qName The qualified name (with prefix), or the empty string if qualified names are not available
attrs 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.

public String saveState ()

Returns a java.lang.String representaion of a component. The returned state should be HTML friendly. This method call is equivalent to call saveState(EnumWebPersistableState.TYPICAL_STATE_INFO).

Returns
  • the serialized state of a component.

public void saveState (StringBuffer buf, int howMuchState)

Saves and stores a component's state into a StringBuffer. 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.

Parameters
buf a StringBuffer to store the saved state.
howMuchState how much state information to save (EnumWebPersistableState).
Throws
UnsupportedOperationException

public String saveState (int howMuchState)

Returns a java.lang.String representaion of a component. The returned state should be HTML friendly. This method call is equivalent to call saveState(new StringBuffer(), howMuchState).

Parameters
howMuchState how much state information to save (EnumWebPersistableState).
Returns
  • the serialized state of a component.

public void saveState (StringBuffer buf, int howMuchState, int stateFlag)

Saves and stores a component's state into a StringBuffer. 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.

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
UnsupportedOperationException

public void setCompression (boolean isCompressed)

Sets whether the content that is delivered is compressed or not

public void setContactSecurity (String useContSec)

Sets whether use Contact Security for each contact group member

public void setEmailSubject (String subject)

Sets the email subject associated with this subscription

Parameters
subject The string that should be used as the subject

public void setExecutionFlags (int execFlags)

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 from EnumDSSXMLExecutionFlags. If the subscription is to a document, then use the execution flags from EnumDSSXMLDocExecutionFlags.

public void setExpiration (String expiration)

Sets the expiration date of the subscription

public void setFileName (String fileName)

Sets the name of the file that will be delivered when the subscription is executed

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

Configures whether the subscription should include data in the delivered email.

public void setIncludeLink (boolean value)

Configures whether a link to the history list is included in the delivered subscription

public void setOverwriteOlderVersion (boolean overwrite)

Sets whether the subscription will overwrite earlier versions of the same report or document in the history list

public void setProtectZipFile (boolean isProtected)

Sets whether the compressed file is password protected.

public void setSendToInbox (boolean value)

Configures whether the subscription adds the message to history list when it is executed

public void setSpaceDelimiter (String spaceDelimiter)

Sets the space delimiter

public void setZipFileName (String fileName)

Returns the name of the compressed file saved in the subscrription

public void setZipFilePassword (String pwd)

Sets the password of the compressed file.