public class

WebIServerSubscriptionDeliveryModeMobilePropertiesImpl

extends AbstractPersistable
implements WebSubscriptionDeliveryModeMobileProperties Cloneable
java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.objects.WebIServerSubscriptionDeliveryModeMobilePropertiesImpl
Known Direct Subclasses

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.EnumWebSubscriptionDeliveryMode
Fields
protected HashList propsMap
Public Methods
Object clone()
String getContactSecurity()
Returns whether use Contact Security for each contact group member
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()
String getMessageTitle()
Get the message title for the mobile alerts
String getMobileAppDeviceId()
Get the mobile target application for the mobile subscription.
String getMobileAppId()
Get the mobile application ID for the mobile subscription.
int getMobileClientType()
Get the mobile client type for the mobile subscription
int getMode()
String getZipFileName()
String getZipFilePassword()
boolean isCompressed()
boolean isDoNotCreateUpdateCaches()
Returns whether the subscription will use a existing cache
boolean isOverwriteOlderVersion()
Returns whether the current subscription will overwrite earlier versions of the same report or document in the history list
boolean isReRunHL()
Returns whether the subscription will re-run against warehouse
boolean isZipFileProtected()
void setCompression(boolean isCompressed)
void setContactSecurity(String useContSec)
Sets whether use Contact Security for each contact group member
void setDoNotCreateUpdateCaches(boolean notCreateUpdateCache)
Sets whether the subscription will use a existing cache
void setExecutionFlags(int flags)
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 name)
void setMessageTitle(String title)
Set the message title for mobile alerts
void setMobileAppDeviceId(String mobileAppDeviceId)
Set the mobile target application for the mobile subscription.
void setMobileAppId(String mobileAppId)
Set the mobile application ID for the mobile subscription.
void setMobileClientType(int mobileClientType)
Set the mobile client type for the mobile 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 protect)
void setReRunHL(boolean ReRunHL)
Sets whether the subscription will re-run against warehouse
void setZipFileName(String fileName)
void setZipFilePassword(String pwd)
Protected Methods
boolean getBooleanValue(String propName)
int getIntValue(String propName)
String getStringValue(String propName)
void saveXMLState(WebXMLBuilder builder, int howMuchState)
void saveXMLState(StringBuffer buf, int howMuchState)
void setBooleanValue(String propName, boolean propValue)
void setIntValue(String prop, int value)
void setStringValue(String prop, String value)
[Expand]
Inherited Methods
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeMobileProperties
From interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeProperties

Fields

protected HashList propsMap

Public Methods

public Object clone ()

public String getContactSecurity ()

Returns whether use Contact Security for each contact group member

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 ()

public String getMessageTitle ()

Get the message title for the mobile alerts

Returns
  • String

public String getMobileAppDeviceId ()

Get the mobile target application for the mobile subscription.
This is a device ID from the list of mobile devices

Returns
  • the mobile target application for the mobile subscription

public String getMobileAppId ()

Get the mobile application ID for the mobile subscription.

Returns
  • the mobile application ID for the mobile subscription

public int getMobileClientType ()

Get the mobile client type for the mobile subscription

Returns
  • int from com.microstrategy.webapi.EnumDSSXMLMobileSubscriptionClientType

public int getMode ()

public String getZipFileName ()

public String getZipFilePassword ()

public boolean isCompressed ()

public boolean isDoNotCreateUpdateCaches ()

Returns whether the subscription will use a existing cache

public boolean isOverwriteOlderVersion ()

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

public boolean isReRunHL ()

Returns whether the subscription will re-run against warehouse

public boolean isZipFileProtected ()

public void setCompression (boolean isCompressed)

public void setContactSecurity (String useContSec)

Sets whether use Contact Security for each contact group member

public void setDoNotCreateUpdateCaches (boolean notCreateUpdateCache)

Sets whether the subscription will use a existing cache

public void setExecutionFlags (int flags)

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 name)

public void setMessageTitle (String title)

Set the message title for mobile alerts

public void setMobileAppDeviceId (String mobileAppDeviceId)

Set the mobile target application for the mobile subscription.
This is a device ID from the list of mobile devices

Parameters
mobileAppDeviceId the mobile target application for the mobile subscription

public void setMobileAppId (String mobileAppId)

Set the mobile application ID for the mobile subscription.

Parameters
mobileAppId the mobile application ID for the mobile subscription

public void setMobileClientType (int mobileClientType)

Set the mobile client type for the mobile subscription

Parameters
mobileClientType int from com.microstrategy.webapi.EnumDSSXMLMobileSubscriptionClientType

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 protect)

public void setReRunHL (boolean ReRunHL)

Sets whether the subscription will re-run against warehouse

public void setZipFileName (String fileName)

public void setZipFilePassword (String pwd)

Protected Methods

protected boolean getBooleanValue (String propName)

protected int getIntValue (String propName)

protected String getStringValue (String propName)

protected void saveXMLState (WebXMLBuilder builder, int howMuchState)

protected void saveXMLState (StringBuffer buf, int howMuchState)

protected void setBooleanValue (String propName, boolean propValue)

protected void setIntValue (String prop, int value)

protected void setStringValue (String prop, String value)