public abstract class

AbstractSubscriptionFolderBeanTransform

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.AbstractSubscriptionFolderBeanTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean.

Summary

Constants
String FP_DELIVERY_MODE
String FP_IMG_DATAMART This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String FP_IMG_DOCUMENT This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String FP_IMG_GRAPH This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String FP_IMG_GRID This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String FP_IMG_GRID_GRAPH This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String FP_IMG_RW_DOCUMENT This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String FP_IMG_SORT_ASC This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String FP_IMG_SORT_ASC_ACTIVE This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String FP_IMG_SORT_DESC This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String FP_IMG_SORT_DESC_ACTIVE This constant is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
String FP_LEVEL_FLAG
String FP_MAX_ITEMS_COUNT
int LEVEL_ALL A flag to show all LEVEL items.
int LEVEL_EDIT Indicates to show a link to edit the subscription
int LEVEL_ICON Indicates to show the icon for the subscription.
int LEVEL_NAME Indicates to show the name of the target of the subscription.
int LEVEL_OWNER Indicates to show the time for the schedule message execution
int LEVEL_PERSONALIZED Indicates to show if the subscription is personalized (i.e., it has prompts).
int LEVEL_RECIPIENT Indicates to show the time for the schedule message execution
int LEVEL_REMOVE Indicates to show a link to delete the subscription
int LEVEL_SORT_ICONS Indicates to show the sorting icons
int LEVEL_SUBSCRIPTION_NAME Indicates to show the subscription name
int LEVEL_TIME Indicates to show the time for the schedule message execution
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected int _deliveryMode
protected String _imgActiveSortAscending This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String _imgActiveSortDescending This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String _imgDatamart This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String _imgDocument This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String _imgGraph This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String _imgGrid This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String _imgGridGraph This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String _imgRwDocument This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String _imgSortAscending This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected String _imgSortDescending This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
protected int _levelFlag
protected int _maxItemCount
protected SubscriptionFolderBean _sfb
public FormalParameter activeSortAscendingImage This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter activeSortDescendingImage This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter datamartImage This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter deliveryMode Indicates which subscriptions this transform will be displaying based on delivery mode.
public FormalParameter documentImage This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter graphImage This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter gridGraphImage This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter gridImage This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter levelFlag Specifies what information is displayed for each subscription.
public FormalParameter maxItemCount Indicates how many subscriptions will be displayed in the list.
public FormalParameter rwDocumentImage This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter sortAscendingImage This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
public FormalParameter sortDescendingImage This field is deprecated. We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractSubscriptionFolderBeanTransform()
Default no-arg constructor, initialize formal parameters
Public Methods
String getPreferenceValue(String preferenceName)
Convenience method that returns the value of a preference.
SubscriptionFolderBean getSubscriptionFolderBean()
Class getSupportedBeanType()
Returns the supported bean type.
boolean hasSubscriptions()
void initializeImages()
Initialize the images to be used by this transform.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
abstract void renderEmptyList(MarkupOutput out)
renders an empty list
void renderFooter(MarkupOutput out)
Render a general footer associated with this transform.
void renderImage(MarkupOutput out, String image)
Renders a transform's image
void renderImage(MarkupOutput out, String image, String title)
Renders a transform's image
abstract void renderList(MarkupOutput out, SimpleList list)
renders the list of components in the SubscriptionFolderBean
void renderPersonalViewSubscriptions(MarkupOutput out, boolean isPublic)
Renders the subscriptions with delivery modes specified Formal parameter deliveryMode will be overwritten by this method
void renderShowMessage(MarkupOutput out)
void renderSubscriptionsByDeliveryMode(MarkupOutput out, int mode)
Renders the subscriptions with delivery modes specified Formal parameter deliveryMode will be overwritten by this method
boolean shouldShowPersonalViewSubscriptionsList(boolean isPublic)
boolean shouldShowSubscriptionsList(int delMode)
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is Successful.
Protected Methods
boolean checkLevel(int level)
JsonGenerator generateBoneProperties(SimpleList list)
int getFieldCount()
String getImageTooltip(WebObjectInfo object)
JsonGenerator getJSGenerator()
boolean isDisplayInfoAvailable(WebObjectInfo target)
boolean isEmpty()
void renderSort(MarkupOutput out, int field)
[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_DELIVERY_MODE

Constant Value: "deliveryMode"

public static final String FP_IMG_DATAMART

This constant is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Constant Value: "datamartImage"

public static final String FP_IMG_DOCUMENT

This constant is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Constant Value: "documentImage"

public static final String FP_IMG_GRAPH

This constant is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Constant Value: "graphImage"

public static final String FP_IMG_GRID

This constant is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Constant Value: "gridImage"

public static final String FP_IMG_GRID_GRAPH

This constant is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Constant Value: "gridGraphImage"

public static final String FP_IMG_RW_DOCUMENT

This constant is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Constant Value: "rwDocumentImage"

public static final String FP_IMG_SORT_ASC

This constant is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Constant Value: "sortAscendingImage"

public static final String FP_IMG_SORT_ASC_ACTIVE

This constant is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Constant Value: "activeSortAscendingImage"

public static final String FP_IMG_SORT_DESC

This constant is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Constant Value: "sortDescendingImage"

public static final String FP_IMG_SORT_DESC_ACTIVE

This constant is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Constant Value: "activeSortDescendingImage"

public static final String FP_LEVEL_FLAG

Constant Value: "levelFlag"

public static final String FP_MAX_ITEMS_COUNT

Constant Value: "maxItemCount"

public static final int LEVEL_ALL

A flag to show all LEVEL items.

Constant Value: 65535 (0x0000ffff)

public static final int LEVEL_EDIT

Indicates to show a link to edit the subscription

Constant Value: 32 (0x00000020)

public static final int LEVEL_ICON

Indicates to show the icon for the subscription.

Constant Value: 1 (0x00000001)

public static final int LEVEL_NAME

Indicates to show the name of the target of the subscription.

Constant Value: 2 (0x00000002)

public static final int LEVEL_OWNER

Indicates to show the time for the schedule message execution

Constant Value: 256 (0x00000100)

public static final int LEVEL_PERSONALIZED

Indicates to show if the subscription is personalized (i.e., it has prompts).

Constant Value: 4 (0x00000004)

public static final int LEVEL_RECIPIENT

Indicates to show the time for the schedule message execution

Constant Value: 512 (0x00000200)

public static final int LEVEL_REMOVE

Indicates to show a link to delete the subscription

Constant Value: 16 (0x00000010)

public static final int LEVEL_SORT_ICONS

Indicates to show the sorting icons

Constant Value: 64 (0x00000040)

public static final int LEVEL_SUBSCRIPTION_NAME

Indicates to show the subscription name

Constant Value: 1024 (0x00000400)

public static final int LEVEL_TIME

Indicates to show the time for the schedule message execution

Constant Value: 128 (0x00000080)

Fields

protected int _deliveryMode

protected String _imgActiveSortAscending

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

protected String _imgActiveSortDescending

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

protected String _imgDatamart

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

protected String _imgDocument

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

protected String _imgGraph

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

protected String _imgGrid

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

protected String _imgGridGraph

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

protected String _imgRwDocument

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

protected String _imgSortAscending

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

protected String _imgSortDescending

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

protected int _levelFlag

protected int _maxItemCount

protected SubscriptionFolderBean _sfb

public FormalParameter activeSortAscendingImage

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Name of the image used to indicate that the current column is sorted in the ascending order.
If a column is sorted in the ascending order, we will render this image next to the column. If this image is clickable, we will sort the column in descending order on clicking on the image.

public FormalParameter activeSortDescendingImage

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Name of the image used to indicate that the current column is sorted in the descending order.
If a column is sorted in the descending order, we will render this image next to the column. If this image is clickable, we will sort the column in ascending order on clicking on the image.

public FormalParameter datamartImage

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Name of the image used to indicate a datamart subscription.

public FormalParameter deliveryMode

Indicates which subscriptions this transform will be displaying based on delivery mode.

public FormalParameter documentImage

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Name of the image used to indicate a document subscription.

public FormalParameter graphImage

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Name of the image used to indicate a graph subscription.

public FormalParameter gridGraphImage

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

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

public FormalParameter gridImage

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Name of the image used to indicate a grid subscription.

public FormalParameter levelFlag

Specifies what information is displayed for each subscription.
The information may include subscription target, edit link, delete link and other information. Multiple fields may be displayed at the same time. Which fields to show is indicated by a bitwise flag.
Allowed Values:

  • Subscription Icon (could be grid/graph/grid-graph/document) = 1
  • Subscription Target (the name of the report/document for which the subscription is created) = 2
  • Personalized (indicates a sign which tells that the subscription is created by answering prompts) = 4
  • Delete Link = 16
  • Edit Link = 32
  • Show sort icons (applicable only for list views) = 64
  • Show the time when the schedule is executed (applicable only for web subscriptions) = 128
  • Show every thing = 65535

Usage:
For example, if you want to specify display icon and target name only, then you would specify (1 + 2 = 3).

public FormalParameter maxItemCount

Indicates how many subscriptions will be displayed in the list.
This value will determine the number of subscriptions rendered in the list. Any negative value would display the entire list of subscriptions.

public FormalParameter rwDocumentImage

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

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

public FormalParameter sortAscendingImage

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Name of the image used to allow the user to perform an ascending sort.
If a column is not sorted we will render this image next to the column to allow the user to perform a ascending sort when the user clicks on it.

public FormalParameter sortDescendingImage

This field is deprecated.
We no longer use these images. Instead we use transforms from the com.microstrategy.web.app.transforms.xhtml package where we render images with CSS classes.

Name of the image used to allow the user to perform a descending sort.
If a column is not sorted we will render this image next to the column to allow the user to perform a descending sort when the user clicks on it.

Public Constructors

public AbstractSubscriptionFolderBeanTransform ()

Default no-arg constructor, initialize formal parameters

Public Methods

public String getPreferenceValue (String preferenceName)

Convenience method that returns the value of a preference. If preferences are not available (in case, for example, the Transform is used outside Microstrategy Web), it returns an empty string.

Parameters
preferenceName name of the preference
Returns
  • the bean being transformed.

public SubscriptionFolderBean getSubscriptionFolderBean ()

Returns
  • the bean being transformed.

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents

Returns
  • WebComponent.class

public boolean hasSubscriptions ()

public void initializeImages ()

Initialize the images to be used by this transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform. Extends initializeTransform by initializing the cache of this transform's Formal parameters.

Parameters
data the bean to transform.

public abstract void renderEmptyList (MarkupOutput out)

renders an empty list

Parameters
out output by this transform

public void renderFooter (MarkupOutput out)

Render a general footer associated with this transform.

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderImage (MarkupOutput out, String image)

Renders a transform's image

Parameters
out where to write the output of the method.
image the image name

public void renderImage (MarkupOutput out, String image, String title)

Renders a transform's image

Parameters
out where to write the output of the method.
image the image name
title the title to use as tooltip.

public abstract void renderList (MarkupOutput out, SimpleList list)

renders the list of components in the SubscriptionFolderBean

Parameters
out output by this transform.
list the list of subscriptions to render.

public void renderPersonalViewSubscriptions (MarkupOutput out, boolean isPublic)

Renders the subscriptions with delivery modes specified Formal parameter deliveryMode will be overwritten by this method

Parameters
out MarkupOutput instance where the HTML output will be saved

public void renderShowMessage (MarkupOutput out)

public void renderSubscriptionsByDeliveryMode (MarkupOutput out, int mode)

Renders the subscriptions with delivery modes specified Formal parameter deliveryMode will be overwritten by this method

Parameters
out MarkupOutput instance where the HTML output will be saved
mode int containing delivery mode from EnumDSSXMLSubscriptionDeliveryType

public boolean shouldShowPersonalViewSubscriptionsList (boolean isPublic)

public boolean shouldShowSubscriptionsList (int delMode)

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is Successful.

Parameters
out output by this transform

Protected Methods

protected boolean checkLevel (int level)

Parameters
level The ID of the column to use. This is determined by the levelFlag FormalParameter Possible values are the LEVEL_ fieds, i.e: LEVEL_ICON
Returns
  • true if the given level is defined in the levelFlag

protected JsonGenerator generateBoneProperties (SimpleList list)

protected int getFieldCount ()

Returns
  • the number fields this transform is displaying, this will depend on the fields that are enabled through the levelFlags formal parameter

protected String getImageTooltip (WebObjectInfo object)

protected JsonGenerator getJSGenerator ()

protected boolean isDisplayInfoAvailable (WebObjectInfo target)

protected boolean isEmpty ()

protected void renderSort (MarkupOutput out, int field)