public abstract class

AbstractSubscriptionEditTransform

extends AbstractAppTransform
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
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

AbstractSubscriptionEditTransform is an abstract class which acts as a super class for all subscription and schedule transforms. Copyright: Copyright (c) 2001

Summary

Constants
String FP_FORM_ID Name for the Formal parameter FP_FORM_ID
String FP_HELP_TOPIC Constant specifying the name of the formal parameter for specifying the help topic for the help of the editor
String FP_HELP_TYPE Constant specifying the type of the help file this editor should point to
String FP_IMG_DATAMART Name for the Formal parameter FP_IMG_DATAMART
String FP_IMG_DOCUMENT Name for the Formal parameter FP_IMG_DOCUMENT
String FP_IMG_GRAPH Name for the Formal parameter FP_IMG_GRAPH
String FP_IMG_GRID Name for the Formal parameter FP_IMG_GRID
String FP_IMG_GRID_GRAPH Name for the Formal parameter FP_IMG_GRID_GRAPH
String FP_IMG_RW_DOCUMENT Name for the Formal parameter FP_IMG_RW_DOCUMENT
String FP_PROMPTS_TRANSFORM_STYLE Name for the Formal parameter FP_PROMPTS_TRANSFORM_STYLE
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
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.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractSubscriptionEditTransform()
Default no argument constructor, initialize formal parameters.
Public Methods
abstract WebEvent getAddEvent()
Event to create a new subscription or schedule.
WebEvent getAddressEvent()
The event to open the Narrowcast address page.
abstract SimpleList getAvailableTriggers()
List of available triggers.
abstract WebEvent getCancelEvent()
The event to cancel the subscription or schedule.
abstract PromptsBean getPromptsBean()
Return the prompts bean associated with the SubscriptionBean or ScheduleBean
WebEvent getPromptsEvent()
The event to answer prompts.
abstract WebEvent getReturnEvent()
The event to execute if the the subscription or schedule is created successfully.
String getTitle()
Title for the dialog
abstract int getViewMode()
The schedule or subscription view mode.
void initializeImages()
Initialize the images to be used by this transform.
void initializeTransform(Transformable data)
Extends initializeTransform by keeping its own copy of the data.
boolean isRWD()
Determine whether the current object is a RW Document
boolean isSubscriptionFromSaveAs()
Returns whether the subscription was triggered from the Save As page.
void renderExecuteButtons(MarkupOutput out)
Render the execute buttons (Ok-Cancel)
void renderFormEnd(MarkupOutput out, boolean hasOpenPrompts)
Renders the FORM end tag.
void renderFormStart(MarkupOutput out, boolean hasOpenPrompts)
Renders the FORM start tag.
void renderIconPane(MarkupOutput out)
This method is deprecated. We no longer render the images when the user tries to edit/create a new subscription.
void renderImage(MarkupOutput out, String image)
Renders an image for this transform
void renderPrompts(MarkupOutput out)
Render the prompts content.
abstract void renderSchedulePane(MarkupOutput out)
Renders the pane containing the list of schedules
void setSubscribeFromSaveAs(boolean subscribeFromSaveAs)
Sets the value of the SubscribeFromSaveAs from the request to a property of the transform
boolean supports(Transformable data)
Overwrites supports by only supporting Subscription and Schedule Beans.
boolean supports(Class type)
Overwrites supports by only supporting Subscription and Schedule Beans.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the bean status is "Successful".
void transformForRequestWaitingForUserInput(MarkupOutput out)
Transform when the bean status is "WaitingForUserInput".
Protected Methods
Tag getDivButtonBar()
abstract WebEvent getPersonalizationLinkEvent()
TransformInstance getPromptsTransform(PromptsBean promptsBean)
Return the transform instance associated with the promptsBean.
abstract WebEvent getUpdatePropertiesEvent()
void initHelp()
void renderCancelButton(MarkupOutput out)
Renders the Cancel button for the wait page.
boolean shouldDisplay()
Determines whether the transform should render itself or not.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_FORM_ID

Name for the Formal parameter FP_FORM_ID

Constant Value: "formID"

public static final String FP_HELP_TOPIC

Constant specifying the name of the formal parameter for specifying the help topic for the help of the editor

Constant Value: "helpTopic"

public static final String FP_HELP_TYPE

Constant specifying the type of the help file this editor should point to

Constant Value: "helpType"

public static final String FP_IMG_DATAMART

Name for the Formal parameter FP_IMG_DATAMART

Constant Value: "datamartImage"

public static final String FP_IMG_DOCUMENT

Name for the Formal parameter FP_IMG_DOCUMENT

Constant Value: "documentImage"

public static final String FP_IMG_GRAPH

Name for the Formal parameter FP_IMG_GRAPH

Constant Value: "graphImage"

public static final String FP_IMG_GRID

Name for the Formal parameter FP_IMG_GRID

Constant Value: "gridImage"

public static final String FP_IMG_GRID_GRAPH

Name for the Formal parameter FP_IMG_GRID_GRAPH

Constant Value: "gridGraphImage"

public static final String FP_IMG_RW_DOCUMENT

Name for the Formal parameter FP_IMG_RW_DOCUMENT

Constant Value: "rwDocumentImage"

public static final String FP_PROMPTS_TRANSFORM_STYLE

Name for the Formal parameter FP_PROMPTS_TRANSFORM_STYLE

Constant Value: "promptsTransformStyle"

Fields

public String PROMPTS_TRANSFORM_STYLE

This field is deprecated.
Please use the promptsTransformStyle Formal Parameter instead

public final String SUBSCRIBE_FROM_SAVEAS

Constant Value: "subscribeFromSaveAs"

public final int VIEW_MODE_BULK_EXPORT

One of the values for the View Mode property in this transform

Constant Value: 6 (0x00000006)

public final int VIEW_MODE_CUBE

One of the values for the View Mode property in this transform

Constant Value: 6 (0x00000006)

public final int VIEW_MODE_DATAMART

One of the values for the View Mode property in this transform

Constant Value: 5 (0x00000005)

public final int VIEW_MODE_DOCUMENT

One of the values for the View Mode property in this transform

Constant Value: 3 (0x00000003)

public final int VIEW_MODE_GRAPH

One of the values for the View Mode property in this transform

Constant Value: 1 (0x00000001)

public final int VIEW_MODE_GRID

One of the values for the View Mode property in this transform

Constant Value: 0 (0x00000000)

public final int VIEW_MODE_GRID_GRAPH

One of the values for the View Mode property in this transform

Constant Value: 2 (0x00000002)

public final int VIEW_MODE_RW_DOCUMENT

One of the values for the View Mode property in this transform

Constant Value: 4 (0x00000004)

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.

Name of the image used to depict a subscription to a datamart.

public FormalParameter documentImage

This field is deprecated.
We no longer render the images when the user tries to edit/create a new subscription.

Name of the image used to depict a subscription to a document.

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.

Name of the image used to depict a subscription to a graph.

public FormalParameter gridGraphImage

This field is deprecated.
We no longer render the images when the user tries to edit/create a new subscription.

Name of the image used to depict a subscription to a grid-graph.

public FormalParameter gridImage

This field is deprecated.
We no longer render the images when the user tries to edit/create a new subscription.

Name of the image used to depict a subscription to a grid.

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.

Name of the image used to depict a subscription to a report writing document.

Public Constructors

public AbstractSubscriptionEditTransform ()

Default no argument constructor, initialize formal parameters.

Public Methods

public abstract WebEvent getAddEvent ()

Event to create a new subscription or schedule.

Returns
  • The event to create a new subscription.

public WebEvent getAddressEvent ()

The event to open the Narrowcast address page.

Returns
  • This method always returns null.

public abstract SimpleList getAvailableTriggers ()

List of available triggers.

Returns
  • The list of Available triggers. Based on whether we are rendering subscriptions or schedules, this method will either return the list of available triggers for subscriptions or schedules.

public abstract WebEvent getCancelEvent ()

The event to cancel the subscription or schedule.

Returns
  • The event to cancel the subscription

public abstract PromptsBean getPromptsBean ()

Return the prompts bean associated with the SubscriptionBean or ScheduleBean

Returns
  • the PromptsBean associated with the SubscriptionBean or ScheduleBean

public WebEvent getPromptsEvent ()

The event to answer prompts.

Returns
  • The EnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ALL_PROMPTS event.

public abstract WebEvent getReturnEvent ()

The event to execute if the the subscription or schedule is created successfully.

Returns
  • The event to execute once the Subscription has been created succesfully

public String getTitle ()

Title for the dialog

Returns
  • the title to be displayed.

public abstract int getViewMode ()

The schedule or 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 schedule.

public void initializeImages ()

Initialize the images to be used by this transform.

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 boolean isRWD ()

Determine whether the current object is a RW Document

Returns
  • true if the document is a RW Document

public boolean isSubscriptionFromSaveAs ()

Returns whether the subscription was triggered from the Save As page.

Returns
  • boolean

public void renderExecuteButtons (MarkupOutput out)

Render the execute buttons (Ok-Cancel)

Parameters
out The transform's output.

public void renderFormEnd (MarkupOutput out, boolean hasOpenPrompts)

Renders the FORM end tag.

Parameters
out Output by this transform
hasOpenPrompts true if there are open prompts in this subscription.

public void renderFormStart (MarkupOutput out, boolean hasOpenPrompts)

Renders the FORM start tag.

Parameters
out Output by this transform.
hasOpenPrompts true if there are open prompts in this subscription.

public void renderIconPane (MarkupOutput out)

This method is deprecated.
We no longer render the images when the user tries to edit/create a new subscription.

Renders The icon pane, based on the view mode

Parameters
out the transform's output.

public void renderImage (MarkupOutput out, String image)

Renders an image for this transform

Parameters
out The transform's output.
image The image name

public void renderPrompts (MarkupOutput out)

Render the prompts content.
It just ask the prompts bean to transform itself using the PROMPTS_TRANSFORM_STYLE style.

Parameters
out the transform's output.

public abstract void renderSchedulePane (MarkupOutput out)

Renders the pane containing the list of schedules

Parameters
out The transform's output.

public void setSubscribeFromSaveAs (boolean subscribeFromSaveAs)

Sets the value of the SubscribeFromSaveAs from the request to a property of the transform

Parameters
subscribeFromSaveAs boolean

public boolean supports (Transformable data)

Overwrites supports by only supporting Subscription and Schedule Beans.

Parameters
data The bean to transform.
Returns
  • true if bean is assignable to a SubscriptionBean or ScheduleBean

public boolean supports (Class type)

Overwrites supports by only supporting Subscription and Schedule Beans.

Parameters
type The bean type.
Returns
  • true if bean is assignable to a SubscriptionBean or ScheduleBean

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the bean status is "Successful". Just calls transformForRequestWaitingForUserInput, which is the correct status. This transform, after collecting and saving the information, expects to go back to its previous page.

Parameters
out Output by this transform

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Transform when the bean status is "WaitingForUserInput". This is the main state when creating a new subscrription or schedule.

Parameters
out Output by this transform.

Protected Methods

protected Tag getDivButtonBar ()

protected abstract WebEvent getPersonalizationLinkEvent ()

protected TransformInstance getPromptsTransform (PromptsBean promptsBean)

Return the transform instance associated with the promptsBean. If the Formal Parameter FP_PROMPTS_TRANSFORM_STYLE is set, it will add that style to the bean and return the transform instance. If not, it will return a new instance of PromptsSubscriptionTransform.

Parameters
promptsBean the prompts bean to transform
Returns
  • the Transform Instance.

protected abstract WebEvent getUpdatePropertiesEvent ()

protected void initHelp ()

protected void renderCancelButton (MarkupOutput out)

Renders the Cancel button for the wait page.
It calls getCancelEvent() to obtain the event for the button
The button is not rendered if:
- getCancelEvent() returns null
- processingButtonsFlags does not have PROCESSING_BUTTONS_CANCEL

Parameters
out output for this transform

protected boolean shouldDisplay ()

Determines whether the transform should render itself or not. Returns the result of !isIFrameRequest() or the result of the hasChanged() method.

Returns
  • boolean