Package com.microstrategy.web.app.transforms

Class AbstractSubscriptionListTransform

    • Field Detail

      • LEVEL_SCHEDULE

        public static final int LEVEL_SCHEDULE
        Indicates to show the schedule column
        See Also:
        Constant Field Values

      • LEVEL_ADDRESS

        public static final int LEVEL_ADDRESS
        Indicates to show the address column
        See Also:
        Constant Field Values

      • VIEW_MODE_RW_DOCUMENT

        protected final int VIEW_MODE_RW_DOCUMENT
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • VIEW_MODE_BULK_EXPORT

        protected final int VIEW_MODE_BULK_EXPORT
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • VIEW_MODE_DATAMART

        protected final int VIEW_MODE_DATAMART
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • VIEW_MODE_CUBE

        protected final int VIEW_MODE_CUBE
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • CMD_PERSONALIZATION

        protected final java.lang.String CMD_PERSONALIZATION
        See Also:
        Constant Field Values

      • CMD_REMOVE_CHECKBOX

        protected final java.lang.String CMD_REMOVE_CHECKBOX
        See Also:
        Constant Field Values

      • execTarget

        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

      • EXEC_TARGET

        public static final java.lang.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.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractSubscriptionListTransform

        public AbstractSubscriptionListTransform()

    • Method Detail

      • getCssName

        protected java.lang.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.
        Since:
        MicroStrategy Web 8.0.0

      • getSubscriptionTarget

        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.

      • getExecuteEvent

        protected WebEvent getExecuteEvent​(WebSubscription subscription)
        Parameters:
        subscription - the subscription object to execute
        Returns:
        a WebEvent to execute the message (i.e., runReports)

      • canTransform

        public boolean canTransform​(Transformable data)
        Overrides canTransform(Transformable) by making sure the SubscriptionFolderBean is set to return a list of WebSubscriptions.
        Specified by:
        canTransform in interface Transform
        Overrides:
        canTransform in class AbstractTransform
        Parameters:
        data - the SubscripptionFolderBean to transform
        Returns:
        true if the getContentType() method returns SubscriptionFolderBean.SUBSCRIPTION_FOLDER_CONTENT_TYPE_SUBSCRIPTION

      • getEmptyListDescriptor

        protected java.lang.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.
        Since:
        MicroStrategy Web 7.5.1

      • getEditSubscriptionEvent

        protected WebEvent getEditSubscriptionEvent()
        Returns:
        WebEvent instance initialized with the information for editing a subscription.
        Since:
        MicroStrategy Web 7.5.1

      • isViewableReport

        protected boolean isViewableReport​(WebObjectInfo object)
        A report is viewable if its subtype is not EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportDatamart, EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportNonInteractive or EnumDSSXMLObjectSubTypes.DssXmlSubTypeReportCube
        Parameters:
        object -
        Returns:
        whether the report is viewable
        Since:
        MicroStrategy Web 9.0.0

      • renderSubscriptionName

        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
        Since:
        MicroStrategy Web 9.0.0

      • hasExecutePermission

        protected boolean hasExecutePermission​(WebObjectInfo target)

      • shouldRenderAction

        protected boolean shouldRenderAction​(WebSubscription subscription,
                                     int changeAbleMask)
        Since:
        MicroStrategy Web 9.0.0

      • isEditSupported

        protected boolean isEditSupported​(WebSubscription subscription)

      • canSubscribe

        protected boolean canSubscribe​(int mode,
                               boolean isAlert)
        Since:
        MicroStrategy Web 9.0.0

      • canSubscribe

        protected boolean canSubscribe​(int mode)

      • generateEditPersonalizationInfoAnchor

        protected Tag generateEditPersonalizationInfoAnchor​(java.lang.String subscriptionID,
                                                    WebObjectInfo target)
        Since:
        MicroStrategy Web 9.0.1

      • isDeliveryModeWithAddress

        protected boolean isDeliveryModeWithAddress()

      • isMultipleRecipientAndEditable

        protected boolean isMultipleRecipientAndEditable​(WebSubscription subscription)