Package com.microstrategy.web.objects

Interface WebSubscriptionDeliveryModeHistoryListProperties

All Superinterfaces:

EnumWebPersistableState, EnumWebSubscriptionDeliveryMode, Persistable, WebSubscriptionDeliveryModeMobileProperties, WebSubscriptionDeliveryModeProperties

public interface WebSubscriptionDeliveryModeHistoryListProperties
extends WebSubscriptionDeliveryModeMobileProperties

This subinterface is used specifically for subscriptions to history list

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	getHistoryLinkURL()	Gets the URL for the link to history list that has been set using setHistoryLinkURL(String)
java.lang.String	getHistoryLinkWebServer()	Gets the default web-server location that has been set at the subscription level.
boolean	isOverwriteOlderVersionSet()	check whether the user has set the OverwriteOlderVersion checkbox.
void	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.

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

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeMobileProperties

getMessageTitle, getMobileAppDeviceId, getMobileAppId, getMobileClientType, isDoNotCreateUpdateCaches, isOverwriteOlderVersion, isReRunHL, setDoNotCreateUpdateCaches, setMessageTitle, setMobileAppDeviceId, setMobileAppId, setMobileClientType, setOverwriteOlderVersion, setReRunHL

Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeProperties

clone, getContactSecurity, getExecutionFlags, getExpiration, getMode, setContactSecurity, setExecutionFlags, setExpiration

Method Detail

setHistoryLinkURL

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

Parameters:

url -

setHistoryLinkWebServer

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

Parameters:

webserver -

getHistoryLinkURL

java.lang.String getHistoryLinkURL()

Gets the URL for the link to history list that has been set using setHistoryLinkURL(String)

Returns:

URL for the link to history list.

getHistoryLinkWebServer

java.lang.String getHistoryLinkWebServer()

Gets the default web-server location that has been set at the subscription level. Please note that this method will not query the Intelligence Server for the project-level property set by the administrator.

isOverwriteOlderVersionSet

boolean isOverwriteOlderVersionSet()

check whether the user has set the OverwriteOlderVersion checkbox. For issue 734188, if the user has set the "The new schedule report will overwrite older (...)" checkbox, the checkbox should not be set back to the default project level setting when using a nested prompt.

Returns:

true if the user has set the OverwriteOlderVersion checkbox.