| 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
|
This transform renders the list of Narrowcast Subscriptions from a SubscriptionFolderBean as Large Icons.
| 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
| |||||||||||
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.
Indicates to show the address column
Indicates to show the schedule column
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
Overrides canTransform(Transformable) by making sure
the SubscriptionFolderBean is set to return a list of WebSubscriptions.
| data | the SubscripptionFolderBean to transform |
|---|
getContentType() method returns SubscriptionFolderBean.SUBSCRIPTION_FOLDER_CONTENT_TYPE_SUBSCRIPTION
Generates the name of the subscription as a link
| content | MarkupOutput instance where the transform's output will be saved. |
|---|---|
| subscription | WebSubscription instance to render |
Transform when the status is In Error. Overwrites
transformForRequestInError by showing a "this feature is currently
unavailable" message.
| out | output by this transform |
|---|
Utility method that helps giving the CSS class to use based on the the subscription type of the WebSubscription instance.
| subscription | The WebSubscription for which it's css name is required. |
|---|
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.WebEvent instance initialized with the information
for editing a subscription.Get the descriptor to display to the user if the list of subscriptions is empty.
| subscription | the subscription object to execute |
|---|
Returns the target object info associated with the given subscription
| subscription | the subscription to check |
|---|
The subscription view mode
| subscription | the subscription to check |
|---|
VIEW_MODE_GRID, VIEW_MODE_GRAPH,
VIEW_MODE_GRID_GRAPH or VIEW_MODE_DOCUMENT accoringly.
| WebObjectsException |
|---|
A report is viewable if its subtype is not EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart, EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportNonInteractive or EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube
If a scriptClass is specified, this method registers the corresponding javascript bone for this component.
| out | MarkupOutput whether the output should be rendered. |
|---|
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.
| boneProps | the JsonGenerator object that contains the collection of bone properties. |
|---|