Package com.microstrategy.web.objects

Interface WebSubscriptionDeliveryModeProperties

All Superinterfaces:

EnumWebPersistableState, EnumWebSubscriptionDeliveryMode, Persistable

All Known Subinterfaces:

WebSubscriptionDeliveryModeCacheProperties, WebSubscriptionDeliveryModeEmailProperties, WebSubscriptionDeliveryModeFileProperties, WebSubscriptionDeliveryModeFTPProperties, WebSubscriptionDeliveryModeHistoryListProperties, WebSubscriptionDeliveryModeMobileProperties, WebSubscriptionDeliveryModePrintProperties

All Known Implementing Classes:

WebIServerSubscriptionDeliveryModeMobilePropertiesImpl, WebIServerSubscriptionDeliveryModePersonalViewPropertiesImpl, WebSubscriptionDeliveryModeEmailPropertiesImpl

public interface WebSubscriptionDeliveryModeProperties
extends EnumWebSubscriptionDeliveryMode, Persistable

Each subscription is associated with a delivery mode. Each delivery mode may define specific properties, which are encapsulated by the relevant WebSubscriptionDeliveryModeProperties 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

Modifier and Type	Method	Description
java.lang.Object	clone()
java.lang.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.
java.lang.String	getExpiration()	Returns the expiration date of the subscription
java.lang.String	getExpirationTimeZone()	Returns the expiration date timezone of the subscription
int	getMode()
void	setContactSecurity(java.lang.String useContSec)	Sets whether use Contact Security for each contact group member
void	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 subscription
void	setExpirationTimeZone(java.lang.String expirationTimeZone, java.lang.String offset)	Sets the expiration date timezone of the subscription

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Method Detail

getMode

int getMode()

Returns:

the associated enumeration from EnumWebSubscriptionDeliveryMode

clone

java.lang.Object clone()

getExpiration

java.lang.String getExpiration()

Returns the expiration date of the subscription

Since:

MicroStrategy Web 9.0.0

getContactSecurity

java.lang.String getContactSecurity()

Returns whether use Contact Security for each contact group member

setExpiration

void setExpiration(java.lang.String expiration)

Sets the expiration date of the subscription

Parameters:

expiration -

Since:

MicroStrategy Web 9.0.0

getExpirationTimeZone

java.lang.String getExpirationTimeZone()

Returns the expiration date timezone of the subscription

Since:

MicroStrategy Web 11.3.4

setExpirationTimeZone

void setExpirationTimeZone(java.lang.String expirationTimeZone,
                           java.lang.String offset)

Sets the expiration date timezone of the subscription

Parameters:

expirationTimeZone -

Since:

MicroStrategy Web 11.3.4

setExecutionFlags

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.

Parameters:

execFlags -

Since:

MicroStrategy Web 9.0.0

getExecutionFlags

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

Since:

MicroStrategy Web 9.0.0

setContactSecurity

void setContactSecurity(java.lang.String useContSec)

Sets whether use Contact Security for each contact group member

Parameters:

useContSec -