Package com.microstrategy.web.objects

Interface WebSubscriptionDeliveryModeMobileProperties

All Superinterfaces:

EnumWebPersistableState, EnumWebSubscriptionDeliveryMode, Persistable, WebSubscriptionDeliveryModeProperties

All Known Subinterfaces:

WebSubscriptionDeliveryModeHistoryListProperties

All Known Implementing Classes:

WebIServerSubscriptionDeliveryModeMobilePropertiesImpl, WebIServerSubscriptionDeliveryModePersonalViewPropertiesImpl

public interface WebSubscriptionDeliveryModeMobileProperties
extends WebSubscriptionDeliveryModeProperties

This sub-interface is used specifically for mobile subscriptions

Since:

MicroStrategy Web 9.0.0

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

Modifier and Type	Method	Description
java.lang.String	getMessageTitle()	Get the message title for the mobile alerts
java.lang.String	getMobileAppDeviceId()	Get the mobile target application for the mobile subscription.
java.lang.String	getMobileAppId()	Get the mobile application ID for the mobile subscription.
int	getMobileClientType()	Get the mobile client type for the mobile subscription
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
void	setDoNotCreateUpdateCaches(boolean notCreateUpdateCache)	Sets whether the subscription will use a existing cache
void	setMessageTitle(java.lang.String title)	Set the message title for mobile alerts
void	setMobileAppDeviceId(java.lang.String mobileAppDeviceId)	Set the mobile target application for the mobile subscription.
void	setMobileAppId(java.lang.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	setReRunHL(boolean ReRunHL)	Sets whether the subscription will re-run against warehouse

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

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

setDoNotCreateUpdateCaches

void setDoNotCreateUpdateCaches(boolean notCreateUpdateCache)

Sets whether the subscription will use a existing cache

Parameters:

notCreateUpdateCache -

isDoNotCreateUpdateCaches

boolean isDoNotCreateUpdateCaches()

Returns whether the subscription will use a existing cache

setReRunHL

void setReRunHL(boolean ReRunHL)

Sets whether the subscription will re-run against warehouse

Parameters:

notCreateUpdateCache -

isReRunHL

boolean isReRunHL()

Returns whether the subscription will re-run against warehouse

setMobileClientType

void setMobileClientType(int mobileClientType)

Set the mobile client type for the mobile subscription

Parameters:

mobileClientType - int from com.microstrategy.webapi.EnumDSSXMLMobileSubscriptionClientType

getMobileClientType

int getMobileClientType()

Get the mobile client type for the mobile subscription

Returns:

int from com.microstrategy.webapi.EnumDSSXMLMobileSubscriptionClientType

getMessageTitle

java.lang.String getMessageTitle()

Get the message title for the mobile alerts

Returns:

String

setMessageTitle

void setMessageTitle(java.lang.String title)

Set the message title for mobile alerts

Parameters:

title -

setMobileAppDeviceId

void setMobileAppDeviceId(java.lang.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

getMobileAppDeviceId

java.lang.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

setMobileAppId

void setMobileAppId(java.lang.String mobileAppId)

Set the mobile application ID for the mobile subscription.

Parameters:

mobileAppId - the mobile application ID for the mobile subscription

getMobileAppId

java.lang.String getMobileAppId()

Get the mobile application ID for the mobile subscription.

Returns:

the mobile application ID for the mobile subscription