public interface

WebSubscriptionDeliveryModeHistoryListProperties

implements WebSubscriptionDeliveryModeMobileProperties
com.microstrategy.web.objects.WebSubscriptionDeliveryModeHistoryListProperties

Class Overview

This subinterface is used specifically for subscriptions to history list

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.EnumWebSubscriptionDeliveryMode
Public Methods
abstract String getHistoryLinkURL()
Gets the URL for the link to history list that has been set using setHistoryLinkURL(String)
abstract String getHistoryLinkWebServer()
Gets the default web-server location that has been set at the subscription level.
abstract boolean isOverwriteOlderVersionSet()
check whether the user has set the OverwriteOlderVersion checkbox.
abstract void setHistoryLinkURL(String url)
Sets the URL for the link to history list.
abstract void setHistoryLinkWebServer(String webserver)
This property stores the default web-server location when the user creates a subscription.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeMobileProperties
From interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeProperties

Public Methods

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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 abstract 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.