public interface

SubscriptionEditorBean

implements ReportFrameElement ViewBeanParserBean
com.microstrategy.web.app.beans.SubscriptionEditorBean

Class Overview

Extends the ReportFrameElement, defines no extra properties.

Summary

Constants
int SUBSCRIPTION_DEFAULT Indicates the editor handles normal (default) subscriptions
int SUBSCRIPTION_MOBILE Indicates the editor handles mobile subscriptions.
int SUBSCRIPTION_NARROWCAST Indicates the editor handles Narrowcast email subscriptions
int SUBSCRIPTION_NARROWCAST_CACHE Indicates the editor handles cache subscriptions.
int SUBSCRIPTION_NARROWCAST_FILE Indicates the editor handles Narrowcast file subscriptions
int SUBSCRIPTION_NARROWCAST_FTP Indicates the editor handles FTP subscriptions.
int SUBSCRIPTION_NARROWCAST_PRINT Indicates the editor handles Narrowcast print subscriptions
int SUBSCRIPTION_PERSONAL_VIEW
int SUBSCRIPTION_SEND_NOW Indicates the editor handles send now subscriptions
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract SimpleList getAddresses()
This method will retrieve the list of available addresses for email subscription.
abstract int getApplyEventId()
Indicates the apply event Id.
abstract SimpleList getAvailableFormats()
This method will retrieve the list of available formats for email subscription.
abstract SimpleList getAvailableLocations()
This method will retrieve the list of available locations for print and file subscription.
abstract SimpleList getDevices()
This method will retrieve the list of available devices for creating addresses for email subscription.
abstract String getEditorMessage()
Returns message to be displayed informing action results.
abstract String getErrorMessage()
Returns error message if any or null if nothing happens.
abstract boolean getExpandLayouts()
abstract int getExpandPageBy(SubscriptionEditorBean subsEditor)
Returns the value of expand pageby option
abstract int getExpandUseSeparateSheets(SubscriptionEditorBean subsEditor)
Returns the value of expand use separate sheets option
abstract String getFileName()
Returns the value of file name
abstract boolean getIsCustomMessageAvailable()
This method will return a true if the feature to set custom message to be delivered with the email is available.
abstract boolean getIsDeliveryNotificationAvailable()
Indicates whether or not the delivery notification option is available.
abstract boolean getIsExpandPageByAvailable(SubscriptionEditorBean subsEditor)
Indicates whether or not the expand pageby option is available
abstract WebSchedule getMobileDuplicate()
abstract SimpleList getNotificationAddresses()
This method will retrieve the list of available notification addresses for subscription.
abstract SimpleList getNotificationDevices()
This method will retrieve the list of available notification devices for subscription.
abstract WebScheduleTrigger getScheduleTrigger()
Indicates the scheduled trigger element.
abstract SimpleListObj getScheduleTriggers()
This method will retrieve the list of available triggers (schedules) for scheduling.
abstract String getSubject()
This method will retrieve the subjsct for email subscription.
abstract SubscriptionBean getSubscriptionBean()
abstract int getSubscriptionObjectViewType()
Indicates what view type is the subscription object.
abstract SimpleList getSubscriptionTriggers()
This method will retrieve the list of available triggers (schedules) for email subscription.
abstract int getSubscriptionType()
Indicates the type of subscriptions the editor handles.
abstract int getSubscriptionsCount()
This method returns the count of subscriptions.
abstract String getTargetBeanParentID()
Obtains parent WebComponent ID of given Target bean.
abstract String getTriggerId()
Indicates Id value for existing subscription trigger.
abstract SimpleListObj getTriggers()
Returns simple list of all available formats in Narrow Caster.
abstract boolean getUseDeliveryNotification()
This method will retrieve the value of use delivery notification for subscription.
abstract boolean hasDuplicate()
abstract boolean hasMobileDuplicate()
abstract boolean isExpandLayoutsAvailable()
abstract boolean isMobile()
abstract boolean isNonSchedulable()
abstract boolean isOverwriteNeeded()
Indicates whether or not current subscription needs to be overwritten.
abstract boolean isPageByChanged()
abstract boolean isSaveNeeded()
Indicates whether or not current subscription needs to be saved.
abstract boolean isUserAllowedToSubscribe()
abstract String reuseMsg()
Indicates The value of the subscription flag.
abstract void setApplyEventId(int value)
Specifies the apply event Id.
abstract void setEditorMessage(String mssg)
Specifies message to be displayed informing action results.
abstract void setHasDuplicate(boolean value)
abstract void setIsOverwriteNeeded(boolean value)
Specifies whether or not current subscription needs to be overwritten.
abstract void setMobile(boolean value)
abstract void setMobileDuplicate(WebSchedule value)
abstract void setReuseMsg(String value)
Specifies The value of the subscription flag.
abstract void setSubscriptionType(int type)
Set the type of subscriptions the editor will handle.
abstract void setTriggerId(String value)
Specifies Id value for existing subscription trigger.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int SUBSCRIPTION_DEFAULT

Indicates the editor handles normal (default) subscriptions

Constant Value: 1 (0x00000001)

public static final int SUBSCRIPTION_MOBILE

Indicates the editor handles mobile subscriptions.

Constant Value: 6 (0x00000006)

public static final int SUBSCRIPTION_NARROWCAST

Indicates the editor handles Narrowcast email subscriptions

Constant Value: 2 (0x00000002)

public static final int SUBSCRIPTION_NARROWCAST_CACHE

Indicates the editor handles cache subscriptions.

Constant Value: 9 (0x00000009)

public static final int SUBSCRIPTION_NARROWCAST_FILE

Indicates the editor handles Narrowcast file subscriptions

Constant Value: 4 (0x00000004)

public static final int SUBSCRIPTION_NARROWCAST_FTP

Indicates the editor handles FTP subscriptions.

Constant Value: 8 (0x00000008)

public static final int SUBSCRIPTION_NARROWCAST_PRINT

Indicates the editor handles Narrowcast print subscriptions

Constant Value: 5 (0x00000005)

public static final int SUBSCRIPTION_PERSONAL_VIEW

Constant Value: 7 (0x00000007)

public static final int SUBSCRIPTION_SEND_NOW

Indicates the editor handles send now subscriptions

Constant Value: 3 (0x00000003)

Public Methods

public abstract SimpleList getAddresses ()

This method will retrieve the list of available addresses for email subscription.

Returns
  • The list of available addresses for email subscription.

public abstract int getApplyEventId ()

Indicates the apply event Id.

Returns
  • int value.

public abstract SimpleList getAvailableFormats ()

This method will retrieve the list of available formats for email subscription.

Returns
  • The list of available formats for email subscription.

public abstract SimpleList getAvailableLocations ()

This method will retrieve the list of available locations for print and file subscription.

Returns
  • The list of available locations for print and file subscription.

public abstract SimpleList getDevices ()

This method will retrieve the list of available devices for creating addresses for email subscription.

Returns
  • The list of available devices for creating addresses for email subscription.

public abstract String getEditorMessage ()

Returns message to be displayed informing action results.

Returns
  • String mssg Text.

public abstract String getErrorMessage ()

Returns error message if any or null if nothing happens.

Returns
  • String text.

public abstract boolean getExpandLayouts ()

public abstract int getExpandPageBy (SubscriptionEditorBean subsEditor)

Returns the value of expand pageby option

Parameters
subsEditor The current subscriptionEditor
Returns
  • the expand pageby value.

public abstract int getExpandUseSeparateSheets (SubscriptionEditorBean subsEditor)

Returns the value of expand use separate sheets option

Parameters
subsEditor The current subscriptionEditor
Returns
  • the expand use separate sheets value

public abstract String getFileName ()

Returns the value of file name

Returns
  • the file name value.

public abstract boolean getIsCustomMessageAvailable ()

This method will return a true if the feature to set custom message to be delivered with the email is available.

Returns
  • true if the feature to set custom message is available

public abstract boolean getIsDeliveryNotificationAvailable ()

Indicates whether or not the delivery notification option is available.

Returns
  • true if delivery notification is available.

public abstract boolean getIsExpandPageByAvailable (SubscriptionEditorBean subsEditor)

Indicates whether or not the expand pageby option is available

Parameters
subsEditor The current subscriptionEditor
Returns
  • true if expand pageby is available.

public abstract WebSchedule getMobileDuplicate ()

public abstract SimpleList getNotificationAddresses ()

This method will retrieve the list of available notification addresses for subscription.

Returns
  • The list of available notification addresses for subscription.

public abstract SimpleList getNotificationDevices ()

This method will retrieve the list of available notification devices for subscription.

Returns
  • The list of available notification devices for subscription.

public abstract WebScheduleTrigger getScheduleTrigger ()

Indicates the scheduled trigger element.

Returns
  • WebScheduleTrigger object.

public abstract SimpleListObj getScheduleTriggers ()

This method will retrieve the list of available triggers (schedules) for scheduling.

Returns
  • The list of available triggers (schedules) for scheduling.

public abstract String getSubject ()

This method will retrieve the subjsct for email subscription.

Returns
  • The subjsct for email subscription.

public abstract SubscriptionBean getSubscriptionBean ()

public abstract int getSubscriptionObjectViewType ()

Indicates what view type is the subscription object.

Returns
  • int value.

public abstract SimpleList getSubscriptionTriggers ()

This method will retrieve the list of available triggers (schedules) for email subscription.

Returns
  • The list of available triggers (schedules) for email subscription.

public abstract int getSubscriptionType ()

Indicates the type of subscriptions the editor handles.

Returns
  • either SUBSCRIPTION_DEFAULT or SUBSCRIPTOIN_SEND_NOW

public abstract int getSubscriptionsCount ()

This method returns the count of subscriptions.

Returns
  • The count of subscriptions.

public abstract String getTargetBeanParentID ()

Obtains parent WebComponent ID of given Target bean.

Returns
  • String ID.

public abstract String getTriggerId ()

Indicates Id value for existing subscription trigger.

Returns
  • String text.

public abstract SimpleListObj getTriggers ()

Returns simple list of all available formats in Narrow Caster.

Returns
  • SimpleListObj instance,

public abstract boolean getUseDeliveryNotification ()

This method will retrieve the value of use delivery notification for subscription.

Returns
  • The current value of use delivery notification for subscription.

public abstract boolean hasDuplicate ()

public abstract boolean hasMobileDuplicate ()

public abstract boolean isExpandLayoutsAvailable ()

public abstract boolean isMobile ()

public abstract boolean isNonSchedulable ()

Returns
  • whether the schedulable

public abstract boolean isOverwriteNeeded ()

Indicates whether or not current subscription needs to be overwritten.

Returns
  • true value.

public abstract boolean isPageByChanged ()

public abstract boolean isSaveNeeded ()

Indicates whether or not current subscription needs to be saved.

Returns
  • true value.

public abstract boolean isUserAllowedToSubscribe ()

Returns
  • whether the allow user to subscribe

public abstract String reuseMsg ()

Indicates The value of the subscription flag.

Returns
  • String text

public abstract void setApplyEventId (int value)

Specifies the apply event Id.

Parameters
value value.

public abstract void setEditorMessage (String mssg)

Specifies message to be displayed informing action results.

Parameters
mssg Text.

public abstract void setHasDuplicate (boolean value)

public abstract void setIsOverwriteNeeded (boolean value)

Specifies whether or not current subscription needs to be overwritten.

Parameters
value boolean flag.

public abstract void setMobile (boolean value)

public abstract void setMobileDuplicate (WebSchedule value)

public abstract void setReuseMsg (String value)

Specifies The value of the subscription flag.

Parameters
value String text.

public abstract void setSubscriptionType (int type)

Set the type of subscriptions the editor will handle.

Parameters
type either SUBSCRIPTION_DEFAULT or SUBSCRIPTOIN_SEND_NOW

public abstract void setTriggerId (String value)

Specifies Id value for existing subscription trigger.

Parameters
value String text.