public abstract class

AbstractSubscriptionListTransform

extends AbstractSubscriptionFolderBeanTransform
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
           ↳ com.microstrategy.web.app.transforms.AbstractSubscriptionListTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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

Summary

Constants
String EXEC_TARGET Constant used as the name for the formal parameter that determines how the user want's to execute the subscription link.
int LEVEL_ADDRESS Indicates to show the address column
int LEVEL_SCHEDULE Indicates to show the schedule column
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected final String CMD_EDIT
protected final String CMD_MULTIPLE
protected final String CMD_PERSONALIZATION
protected final String CMD_REMOVE
protected final String CMD_REMOVE_CHECKBOX
protected final String CMD_TARGET
protected final String CMD_TARGET_ICON
protected final int VIEW_MODE_BULK_EXPORT
protected final int VIEW_MODE_CUBE
protected final int VIEW_MODE_DASHBOARD
protected final int VIEW_MODE_DATAMART
protected final int VIEW_MODE_DOCUMENT
protected final int VIEW_MODE_GRAPH
protected final int VIEW_MODE_GRID
protected final int VIEW_MODE_GRID_GRAPH
protected final int VIEW_MODE_REPORT_IR
protected final int VIEW_MODE_RW_DOCUMENT
public FormalParameter execTarget Determines how the user want's to execute the subscription link.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractSubscriptionListTransform()
Public Methods
boolean canTransform(Transformable data)
Overrides canTransform(Transformable) by making sure the SubscriptionFolderBean is set to return a list of WebSubscriptions.
void renderSubscriptionName(MarkupOutput content, WebSubscription subscription)
Generates the name of the subscription as a link
void transformForRequestInError(MarkupOutput out)
Transform when the status is In Error.
Protected Methods
boolean canSubscribe(int mode)
boolean canSubscribe(int mode, boolean isAlert)
JsonGenerator generateBoneProperties(SimpleList list)
Tag generateEditPersonalizationInfoAnchor(String subscriptionID, WebObjectInfo target)
void generateTargetNameProps(JsonGenerator props, WebObjectInfo target)
String getCssName(WebSubscription subscription)
Utility method that helps giving the CSS class to use based on the the subscription type of the WebSubscription instance.
WebEvent getEditSubscriptionEvent()
String getEmptyListDescriptor()
Get the descriptor to display to the user if the list of subscriptions is empty.
WebEvent getExecuteEvent(WebSubscription subscription)
WebObjectInfo getSubscriptionTarget(WebSubscription subscription)
Returns the target object info associated with the given subscription
int getViewMode(WebSubscription subscription)
The subscription view mode
boolean hasExecutePermission(WebObjectInfo target)
boolean isCurrentUserSubscriptionOwner(WebSubscription subscription)
boolean isDeliveryModeWithAddress()
boolean isEditSupported(WebSubscription subscription)
boolean isMultipleRecipientAndEditable(WebSubscription subscription)
boolean isViewableReport(WebObjectInfo object)
A report is viewable if its subtype is not EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart, EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportNonInteractive or EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube
void renderRegisterBone(MarkupOutput out)
If a scriptClass is specified, this method registers the corresponding javascript bone for this component.
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
boolean shouldRenderAction(WebSubscription subscription, int changeAbleMask)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractSubscriptionFolderBeanTransform
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 EXEC_TARGET

Constant used as the name for the formal parameter that determines how the user want's to execute the subscription link. If set to "_blank" it will open a new window, if empty the link will be executed in the same window.

Constant Value: "execTarget"

public static final int LEVEL_ADDRESS

Indicates to show the address column

Constant Value: 512 (0x00000200)

public static final int LEVEL_SCHEDULE

Indicates to show the schedule column

Constant Value: 256 (0x00000100)

Fields

protected final String CMD_EDIT

Constant Value: "edit"

protected final String CMD_MULTIPLE

Constant Value: "mult"

protected final String CMD_PERSONALIZATION

Constant Value: "psn"

protected final String CMD_REMOVE

Constant Value: "rmv"

protected final String CMD_REMOVE_CHECKBOX

Constant Value: "chk"

protected final String CMD_TARGET

Constant Value: "tgt"

protected final String CMD_TARGET_ICON

Constant Value: "tgti"

protected final int VIEW_MODE_BULK_EXPORT

Constant Value: 5 (0x00000005)

protected final int VIEW_MODE_CUBE

Constant Value: 7 (0x00000007)

protected final int VIEW_MODE_DASHBOARD

Constant Value: 9 (0x00000009)

protected final int VIEW_MODE_DATAMART

Constant Value: 6 (0x00000006)

protected final int VIEW_MODE_DOCUMENT

Constant Value: 3 (0x00000003)

protected final int VIEW_MODE_GRAPH

Constant Value: 1 (0x00000001)

protected final int VIEW_MODE_GRID

Constant Value: 0 (0x00000000)

protected final int VIEW_MODE_GRID_GRAPH

Constant Value: 2 (0x00000002)

protected final int VIEW_MODE_REPORT_IR

Constant Value: 8 (0x00000008)

protected final int VIEW_MODE_RW_DOCUMENT

Constant Value: 4 (0x00000004)

public FormalParameter execTarget

Determines how the user want's to execute the subscription link. If set to "_blank" it will open a new window, if empty the link will be executed in the same window. Note that this is not apply for PDF export

Public Constructors

public AbstractSubscriptionListTransform ()

Public Methods

public boolean canTransform (Transformable data)

Overrides canTransform(Transformable) by making sure the SubscriptionFolderBean is set to return a list of WebSubscriptions.

Parameters
data the SubscripptionFolderBean to transform
Returns
  • true if the getContentType() method returns SubscriptionFolderBean.SUBSCRIPTION_FOLDER_CONTENT_TYPE_SUBSCRIPTION

public void renderSubscriptionName (MarkupOutput content, WebSubscription subscription)

Generates the name of the subscription as a link

Parameters
content MarkupOutput instance where the transform's output will be saved.
subscription WebSubscription instance to render

public void transformForRequestInError (MarkupOutput out)

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

Parameters
out output by this transform

Protected Methods

protected boolean canSubscribe (int mode)

protected boolean canSubscribe (int mode, boolean isAlert)

protected JsonGenerator generateBoneProperties (SimpleList list)

protected Tag generateEditPersonalizationInfoAnchor (String subscriptionID, WebObjectInfo target)

protected void generateTargetNameProps (JsonGenerator props, WebObjectInfo target)

protected String getCssName (WebSubscription subscription)

Utility method that helps giving the CSS class to use based on the the subscription type of the WebSubscription instance.

Parameters
subscription The WebSubscription for which it's css name is required.
Returns
  • a String with the name of the CSS class that should be associated with the WebSubscription information to display. If the type specified does not match the predefined list of styles, then it returns g by default, corresponding to the css of a grid.

protected WebEvent getEditSubscriptionEvent ()

Returns
  • WebEvent instance initialized with the information for editing a subscription.

protected String getEmptyListDescriptor ()

Get the descriptor to display to the user if the list of subscriptions is empty.

Returns
  • the descriptor to render to the user if the list is empty, depending on the delivery mode defined.

protected WebEvent getExecuteEvent (WebSubscription subscription)

Parameters
subscription the subscription object to execute
Returns
  • a WebEvent to execute the message (i.e., runReports)
    The event used to execute the subscription.

protected WebObjectInfo getSubscriptionTarget (WebSubscription subscription)

Returns the target object info associated with the given subscription

Parameters
subscription the subscription to check
Returns
  • the objectinfo (populated) that is the target of the given subscription.

protected int getViewMode (WebSubscription subscription)

The subscription view mode

Parameters
subscription the subscription to check

protected boolean hasExecutePermission (WebObjectInfo target)

protected boolean isCurrentUserSubscriptionOwner (WebSubscription subscription)

protected boolean isDeliveryModeWithAddress ()

protected boolean isEditSupported (WebSubscription subscription)

protected boolean isMultipleRecipientAndEditable (WebSubscription subscription)

protected boolean isViewableReport (WebObjectInfo object)

A report is viewable if its subtype is not EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart, EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportNonInteractive or EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube

Returns
  • whether the report is viewable

protected void renderRegisterBone (MarkupOutput out)

If a scriptClass is specified, this method registers the corresponding javascript bone for this component.

Parameters
out MarkupOutput whether the output should be rendered.

protected void setBoneProperties (JsonGenerator boneProps)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
boneProps the JsonGenerator object that contains the collection of bone properties.

protected boolean shouldRenderAction (WebSubscription subscription, int changeAbleMask)