Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

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

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.app.beans.FrameElement

abstract FrameBean	getFrameBean() Returns the frame bean that is containing this FrameElement.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract boolean	getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output
abstract boolean	isEditor() Indicates whether a ReportFrameElement most be considered editor.
abstract boolean	isEnabled() Indicates whether a ReportFrameElement is Enabled.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output

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

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

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.

Interfaces

Classes

Exceptions

SubscriptionEditorBean

Class Overview

Summary

Constants

public static final int SUBSCRIPTION_DEFAULT

public static final int SUBSCRIPTION_MOBILE

public static final int SUBSCRIPTION_NARROWCAST

public static final int SUBSCRIPTION_NARROWCAST_CACHE

public static final int SUBSCRIPTION_NARROWCAST_FILE

public static final int SUBSCRIPTION_NARROWCAST_FTP

public static final int SUBSCRIPTION_NARROWCAST_PRINT

public static final int SUBSCRIPTION_PERSONAL_VIEW

public static final int SUBSCRIPTION_SEND_NOW

Public Methods

public abstract SimpleList getAddresses ()

Returns

public abstract int getApplyEventId ()

Returns

public abstract SimpleList getAvailableFormats ()

Returns

public abstract SimpleList getAvailableLocations ()

Returns

public abstract SimpleList getDevices ()

Returns

public abstract String getEditorMessage ()

Returns

public abstract String getErrorMessage ()

Returns

public abstract boolean getExpandLayouts ()

public abstract int getExpandPageBy (SubscriptionEditorBean subsEditor)

Parameters

Returns

public abstract int getExpandUseSeparateSheets (SubscriptionEditorBean subsEditor)

Parameters

Returns

public abstract String getFileName ()

Returns

public abstract boolean getIsCustomMessageAvailable ()

Returns

public abstract boolean getIsDeliveryNotificationAvailable ()

Returns

public abstract boolean getIsExpandPageByAvailable (SubscriptionEditorBean subsEditor)

Parameters

Returns

public abstract WebSchedule getMobileDuplicate ()

public abstract SimpleList getNotificationAddresses ()

Returns

public abstract SimpleList getNotificationDevices ()

Returns

public abstract WebScheduleTrigger getScheduleTrigger ()

Returns

public abstract SimpleListObj getScheduleTriggers ()

Returns

public abstract String getSubject ()

Returns

public abstract SubscriptionBean getSubscriptionBean ()

public abstract int getSubscriptionObjectViewType ()

Returns

public abstract SimpleList getSubscriptionTriggers ()

Returns

public abstract int getSubscriptionType ()

Returns

public abstract int getSubscriptionsCount ()

Returns

public abstract String getTargetBeanParentID ()

Returns

public abstract String getTriggerId ()

Returns

public abstract SimpleListObj getTriggers ()

Returns

public abstract boolean getUseDeliveryNotification ()

Returns

public abstract boolean hasDuplicate ()

public abstract boolean hasMobileDuplicate ()

public abstract boolean isExpandLayoutsAvailable ()

public abstract boolean isMobile ()

public abstract boolean isNonSchedulable ()