public class

SubscriptionEditTransform

extends AbstractSubscriptionEditTransform

java.lang.Object
↳	com.microstrategy.web.transform.AbstractTransform
	↳	com.microstrategy.web.transform.AbstractLayoutTransform
		↳	com.microstrategy.web.app.transforms.AbstractAppTransform
			↳	com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform
				↳	com.microstrategy.web.app.transforms.SubscriptionEditTransform

Known Direct Subclasses

SubscriptionConfirmTransform, SubscriptionEditFileTransform, SubscriptionPersonalViewTransform, SubscriptionSendNowTransform

Known Indirect Subclasses

SubscriptionConfirmSendNowTransform, SubscriptionEditCacheTransform, SubscriptionEditFTPTransform, SubscriptionEditInboxTransform, SubscriptionEditMobileTransform, SubscriptionEditPrintTransform

Class Overview

This class renders the output to create/edit an email subscription. It supports creating email subscriptions for prompted and non-prompted reports. It uses a SubscriptionBean for this.

Summary

Nested Classes
interface	SubscriptionEditTransform.NCSRecipientContext
class	SubscriptionEditTransform.RecipientContext

Constants
String	FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH	Name for the formal parameter `FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH`

[Expand]

Inherited Constants

From class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

Fields
protected WebEvent	_addEvent	The event for the creating the subscription
protected boolean	_allowSubscription
protected WebEvent	_cancelEvent	The event for the canceling the current action
protected boolean	_isUserAllowedToSubscribe
protected WebEvent	_personalizationLinkEvent
protected WebEvent	_returnEvent	The event for the returning to the previous state
protected String	_subscribeGraphAsGridGraph	The boolean value to indicate if graphs are to be subscribed as grid-graph.
protected SubscriptionBean	_subscriptionBean
protected WebEvent	_updatePropertiesEvent
public FormalParameter	subscribeGraphAsGridGraph	Indicates if graphs are to be subscribed as grid-graph.

[Expand]

Inherited Fields

From class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform

public String	PROMPTS_TRANSFORM_STYLE	This field is deprecated. Please use the `promptsTransformStyle` Formal Parameter instead
public final String	SUBSCRIBE_FROM_SAVEAS
public final int	VIEW_MODE_BULK_EXPORT	One of the values for the View Mode property in this transform
public final int	VIEW_MODE_CUBE	One of the values for the View Mode property in this transform
public final int	VIEW_MODE_DATAMART	One of the values for the View Mode property in this transform
public final int	VIEW_MODE_DOCUMENT	One of the values for the View Mode property in this transform
public final int	VIEW_MODE_GRAPH	One of the values for the View Mode property in this transform
public final int	VIEW_MODE_GRID	One of the values for the View Mode property in this transform
public final int	VIEW_MODE_GRID_GRAPH	One of the values for the View Mode property in this transform
public final int	VIEW_MODE_RW_DOCUMENT	One of the values for the View Mode property in this transform
protected String	_helpTopic
protected String	_helpType
public FormalParameter	datamartImage	This field is deprecated. We no longer render the images when the user tries to edit/create a new subscription.
public FormalParameter	documentImage	This field is deprecated. We no longer render the images when the user tries to edit/create a new subscription.
public FormalParameter	formID	The ID and the name to use for the subscriptions's HTML FORM tag.
public FormalParameter	graphImage	This field is deprecated. We no longer render the images when the user tries to edit/create a new subscription.
public FormalParameter	gridGraphImage	This field is deprecated. We no longer render the images when the user tries to edit/create a new subscription.
public FormalParameter	gridImage	This field is deprecated. We no longer render the images when the user tries to edit/create a new subscription.
public FormalParameter	helpTopic	Indicates the help topic for the help page of the editor.
public FormalParameter	helpType	Indicates the type of help topic this editor uses.
public FormalParameter	promptsTransformStyle	Name of the style to apply for rendering prompts on this transform.
public FormalParameter	rwDocumentImage	This field is deprecated. We no longer render the images when the user tries to edit/create a new subscription.

From class com.microstrategy.web.app.transforms.AbstractAppTransform

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

Public Constructors
	SubscriptionEditTransform() Default no argument constructor, initialize formal parameters.

Public Methods
WebEvent	getAddEvent() The event to create a new subscription.
WebEvent	getAddressEvent() The event to go to the address page.
SimpleList	getAvailableTriggers() Return the list of available triggers for subscription.
WebEvent	getCancelEvent() The event to cancel the subscription.
WebSubscriptionContentFormat	getCurrentFormat() Returns the current format for this subscription used when creating the subscription.
String	getDescription() Returns the description of this transform.
PromptsBean	getPromptsBean() Return the PromptsBean associated with the SubscriptionBean.
WebEvent	getReturnEvent() The event to trigger after the subscription is saved correctly.
SubscriptionWidget	getSubscriptionWidget() The subscription widget used to render the subscription pane.
Class	getSupportedBeanType() Returns the supported bean type for the transform.
int	getViewMode() The subscription view mode.
void	initializeTransform(Transformable data) Extends `initializeTransform` by keeping its own copy of the data.
void	renderJobExpiredSection(MarkupOutput out) Renders the job expired section, including an error message and an reexecute button
void	renderSchedulePane(MarkupOutput out) Renders the schedule pane for the user to subscribe to a report or document.
void	renderShell(MarkupOutput out) Generates the shell for this Transform.
boolean	supports(Class type) Overrrides `supports` by only supporting `SubscriptionBean`.
void	transformForRequestInError(MarkupOutput out) Transform when the status is `In Error`.

Protected Methods
WebEvent	getPersonalizationLinkEvent()
SubscriptionBean	getSubscriptionBean() Return the the SubscriptionBean that this transform is going to transform.
WebEvent	getUpdatePropertiesEvent()
void	initWidget(DefaultSubscriptionWidget widget, WebEvent addEvent)
void	setExpandLayoutProperties(DefaultSubscriptionWidget widget, WebEvent addEvent)
void	setExpandPageByProperties(DefaultSubscriptionWidget widget, WebEvent addEvent) setExpandPageByProperties

[Expand]

Inherited Methods

From class com.microstrategy.web.app.transforms.AbstractSubscriptionEditTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

From class com.microstrategy.web.transform.AbstractLayoutTransform

From class com.microstrategy.web.transform.AbstractTransform

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

From class java.lang.Object

From interface com.microstrategy.web.app.transforms.AppTransform

From interface com.microstrategy.web.transform.Transform

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

Constants

public static final String FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH

Name for the formal parameter FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH

Constant Value: "subscribeGraphAsGridGraph"

Fields

protected WebEvent _addEvent

The event for the creating the subscription

protected boolean _allowSubscription

protected WebEvent _cancelEvent

The event for the canceling the current action

protected boolean _isUserAllowedToSubscribe

protected WebEvent _personalizationLinkEvent

protected WebEvent _returnEvent

The event for the returning to the previous state

protected String _subscribeGraphAsGridGraph

The boolean value to indicate if graphs are to be subscribed as grid-graph.

protected SubscriptionBean _subscriptionBean

protected WebEvent _updatePropertiesEvent

public FormalParameter subscribeGraphAsGridGraph

Indicates if graphs are to be subscribed as grid-graph. If we are subscribing to a graph and this proerty is set to true, then we will create a subscription for a grid-grah rather than a graph. This property is usually mapped to a graph preference which indicates if we want to run all graphs as grid-graphs.
If this formal parameter is set to "1", it will be treated as true.

Public Constructors

public SubscriptionEditTransform ()

Default no argument constructor, initialize formal parameters.

Public Methods

public WebEvent getAddEvent ()

The event to create a new subscription.

Returns

The EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_SAVE event

public WebEvent getAddressEvent ()

The event to go to the address page.

Returns

The EnumServletEvents.WebEventNCAddresses event

public SimpleList getAvailableTriggers ()

Return the list of available triggers for subscription.

Returns

The list of Available triggers.

public WebEvent getCancelEvent ()

The event to cancel the subscription.

Returns

The EnumSubscriptionBeanEvents.SUBSCRIPTION_EVENT_CANCEL event.

public WebSubscriptionContentFormat getCurrentFormat ()

Returns the current format for this subscription used when creating the subscription. This could be HTML or EXCEL or PDF or any other such format.

Returns

The current subscription format.

public String getDescription ()

Returns the description of this transform. This is used in the style catalog editor.

Returns

The description of this transform.

public PromptsBean getPromptsBean ()

Return the PromptsBean associated with the SubscriptionBean.

Returns

The PromptsBean associated with the SubscriptionBean.

public WebEvent getReturnEvent ()

The event to trigger after the subscription is saved correctly.

Returns

By default, the EnumServletEvents.WebEventCancel event, however if coming from the SaveAs page, it returns the EnumServletEvents.WebEventOpenObjectSubscriptions, to go to the list of subscriptions.

public SubscriptionWidget getSubscriptionWidget ()

The subscription widget used to render the subscription pane.

Returns

A com.microstrategy.web.app.transforms.SubscriptionWidget instance.

public Class getSupportedBeanType ()

Returns the supported bean type for the transform.

Returns

The SubscriptionBean bean for this transform.

public int getViewMode ()

The subscription view mode. Possible values are VIEW_MODE_GRID, VIEW_MODE_GRAPH, VIEW_MODE_GRID_GRAPH or VIEW_MODE_DOCUMENT.

Returns

The view mode of the subscription.

public void initializeTransform (Transformable data)

Extends initializeTransform by keeping its own copy of the data. This method initializes the private and protected fields of the transform. It also invokes the initializeTransform method of the parent.

Parameters

data	the bean to transform.

public void renderJobExpiredSection (MarkupOutput out)

Renders the job expired section, including an error message and an reexecute button

Parameters

out	Output by this transform

public void renderSchedulePane (MarkupOutput out)

Renders the schedule pane for the user to subscribe to a report or document. It uses an instance of the com.microstrategy.web.app.transforms.SubscriptionWidget for this purpose.

Parameters

out	Output by this transform.

public void renderShell (MarkupOutput out)

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Parameters

out	output by this transform

public boolean supports (Class type)

Overrrides supports by only supporting SubscriptionBean.

Parameters

type	The bean type.

Returns

true if bean is assignable to a SubscriptionBean.

public void transformForRequestInError (MarkupOutput out)

Transform when the status is In Error. Overwrites transformForRequestInError by showing a "The email subscription feature is currently unavailable" message.

Parameters

out	Output by this transform

Protected Methods

protected WebEvent getPersonalizationLinkEvent ()

protected SubscriptionBean getSubscriptionBean ()

Return the the SubscriptionBean that this transform is going to transform.

Returns

A SubscriptionBean instance

protected WebEvent getUpdatePropertiesEvent ()

protected void initWidget (DefaultSubscriptionWidget widget, WebEvent addEvent)

Throws

WebBeanException

protected void setExpandLayoutProperties (DefaultSubscriptionWidget widget, WebEvent addEvent)

protected void setExpandPageByProperties (DefaultSubscriptionWidget widget, WebEvent addEvent)

setExpandPageByProperties

Parameters

widget	SubscriptionWidget
addEvent	WebEvent

Interfaces

Classes

SubscriptionEditTransform

Class Overview

Summary

Constants

public static final String FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH

Fields

protected WebEvent _addEvent

protected boolean _allowSubscription

protected WebEvent _cancelEvent

protected boolean _isUserAllowedToSubscribe

protected WebEvent _personalizationLinkEvent

protected WebEvent _returnEvent

protected String _subscribeGraphAsGridGraph

protected SubscriptionBean _subscriptionBean

protected WebEvent _updatePropertiesEvent

public FormalParameter subscribeGraphAsGridGraph

Public Constructors

public SubscriptionEditTransform ()

Public Methods

public WebEvent getAddEvent ()

Returns

public WebEvent getAddressEvent ()

Returns

public SimpleList getAvailableTriggers ()

Returns

public WebEvent getCancelEvent ()

Returns

public WebSubscriptionContentFormat getCurrentFormat ()

Returns

public String getDescription ()

Returns

public PromptsBean getPromptsBean ()

Returns

public WebEvent getReturnEvent ()

Returns

public SubscriptionWidget getSubscriptionWidget ()

Returns

public Class getSupportedBeanType ()

Returns

public int getViewMode ()

Returns

public void initializeTransform (Transformable data)

Parameters

public void renderJobExpiredSection (MarkupOutput out)

Parameters

public void renderSchedulePane (MarkupOutput out)

Parameters

public void renderShell (MarkupOutput out)

Parameters

public boolean supports (Class type)

Parameters

Returns

public void transformForRequestInError (MarkupOutput out)

Parameters

Protected Methods

protected WebEvent getPersonalizationLinkEvent ()

protected SubscriptionBean getSubscriptionBean ()

Returns

protected WebEvent getUpdatePropertiesEvent ()

protected void initWidget (DefaultSubscriptionWidget widget, WebEvent addEvent)

Throws

protected void setExpandLayoutProperties (DefaultSubscriptionWidget widget, WebEvent addEvent)

protected void setExpandPageByProperties (DefaultSubscriptionWidget widget, WebEvent addEvent)

Parameters