Class AbstractSubscriptionFolderBeanTransform

    • Field Detail

      • LEVEL_ICON

        public static final int LEVEL_ICON
        Indicates to show the icon for the subscription.
        See Also:
        Constant Field Values
      • LEVEL_NAME

        public static final int LEVEL_NAME
        Indicates to show the name of the target of the subscription.
        See Also:
        Constant Field Values
      • LEVEL_PERSONALIZED

        public static final int LEVEL_PERSONALIZED
        Indicates to show if the subscription is personalized (i.e., it has prompts).
        See Also:
        Constant Field Values
      • LEVEL_REMOVE

        public static final int LEVEL_REMOVE
        Indicates to show a link to delete the subscription
        See Also:
        Constant Field Values
      • LEVEL_EDIT

        public static final int LEVEL_EDIT
        Indicates to show a link to edit the subscription
        See Also:
        Constant Field Values
      • LEVEL_SORT_ICONS

        public static final int LEVEL_SORT_ICONS
        Indicates to show the sorting icons
        See Also:
        Constant Field Values
      • LEVEL_TIME

        public static final int LEVEL_TIME
        Indicates to show the time for the schedule message execution
        See Also:
        Constant Field Values
      • LEVEL_OWNER

        public static final int LEVEL_OWNER
        Indicates to show the time for the schedule message execution
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • LEVEL_RECIPIENT

        public static final int LEVEL_RECIPIENT
        Indicates to show the time for the schedule message execution
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • LEVEL_SUBSCRIPTION_NAME

        public static final int LEVEL_SUBSCRIPTION_NAME
        Indicates to show the subscription name
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • LEVEL_ALL

        public static final int LEVEL_ALL
        A flag to show all LEVEL items.
        See Also:
        Constant Field Values
      • FP_IMG_GRAPH

        @Deprecated
        public static final java.lang.String FP_IMG_GRAPH
        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.
        See Also:
        Constant Field Values
      • FP_IMG_GRID

        @Deprecated
        public static final java.lang.String FP_IMG_GRID
        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.
        See Also:
        Constant Field Values
      • FP_IMG_DATAMART

        @Deprecated
        public static final java.lang.String FP_IMG_DATAMART
        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.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values
      • FP_IMG_GRID_GRAPH

        @Deprecated
        public static final java.lang.String FP_IMG_GRID_GRAPH
        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.
        See Also:
        Constant Field Values
      • FP_IMG_DOCUMENT

        @Deprecated
        public static final java.lang.String FP_IMG_DOCUMENT
        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.
        See Also:
        Constant Field Values
      • FP_IMG_RW_DOCUMENT

        @Deprecated
        public static final java.lang.String FP_IMG_RW_DOCUMENT
        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.
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values
      • FP_IMG_SORT_ASC

        @Deprecated
        public static final java.lang.String FP_IMG_SORT_ASC
        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.
        See Also:
        Constant Field Values
      • FP_IMG_SORT_DESC

        @Deprecated
        public static final java.lang.String FP_IMG_SORT_DESC
        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.
        See Also:
        Constant Field Values
      • FP_IMG_SORT_ASC_ACTIVE

        @Deprecated
        public static final java.lang.String FP_IMG_SORT_ASC_ACTIVE
        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.
        See Also:
        Constant Field Values
      • FP_IMG_SORT_DESC_ACTIVE

        @Deprecated
        public static final java.lang.String FP_IMG_SORT_DESC_ACTIVE
        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.
        See Also:
        Constant Field Values
      • FP_MAX_ITEMS_COUNT

        public static final java.lang.String FP_MAX_ITEMS_COUNT
        See Also:
        Constant Field Values
      • FP_DELIVERY_MODE

        public static final java.lang.String FP_DELIVERY_MODE
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • graphImage

        @Deprecated
        public FormalParameter graphImage
        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.
      • _imgGraph

        @Deprecated
        protected java.lang.String _imgGraph
        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.
      • gridImage

        @Deprecated
        public FormalParameter gridImage
        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.
      • _imgGrid

        @Deprecated
        protected java.lang.String _imgGrid
        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.
      • datamartImage

        @Deprecated
        public FormalParameter datamartImage
        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.
        Since:
        MicroStrategy Web 7.5.0
      • _imgDatamart

        @Deprecated
        protected java.lang.String _imgDatamart
        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.
        Since:
        MicroStrategy Web 7.5.0
      • gridGraphImage

        @Deprecated
        public FormalParameter gridGraphImage
        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.
      • _imgGridGraph

        @Deprecated
        protected java.lang.String _imgGridGraph
        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.
      • documentImage

        @Deprecated
        public FormalParameter documentImage
        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.
      • _imgDocument

        @Deprecated
        protected java.lang.String _imgDocument
        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.
      • rwDocumentImage

        @Deprecated
        public FormalParameter rwDocumentImage
        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.
        Since:
        MicroStrategy Web 7.5.0
      • _imgRwDocument

        @Deprecated
        protected java.lang.String _imgRwDocument
        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.
        Since:
        MicroStrategy Web 7.5.0
      • sortAscendingImage

        @Deprecated
        public FormalParameter sortAscendingImage
        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.
      • _imgSortAscending

        @Deprecated
        protected java.lang.String _imgSortAscending
        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.
      • sortDescendingImage

        @Deprecated
        public FormalParameter sortDescendingImage
        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.
      • _imgSortDescending

        @Deprecated
        protected java.lang.String _imgSortDescending
        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.
      • activeSortAscendingImage

        @Deprecated
        public FormalParameter activeSortAscendingImage
        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.
      • _imgActiveSortAscending

        @Deprecated
        protected java.lang.String _imgActiveSortAscending
        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.
      • activeSortDescendingImage

        @Deprecated
        public FormalParameter activeSortDescendingImage
        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.
      • _imgActiveSortDescending

        @Deprecated
        protected java.lang.String _imgActiveSortDescending
        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.
      • levelFlag

        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).
      • _levelFlag

        protected int _levelFlag
      • maxItemCount

        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.
      • _maxItemCount

        protected int _maxItemCount
      • deliveryMode

        public FormalParameter deliveryMode
        Indicates which subscriptions this transform will be displaying based on delivery mode.
        Since:
        MicroStrategy Web 9.0.0
      • _deliveryMode

        protected int _deliveryMode
        Since:
        MicroStrategy Web 9.0.0
    • Constructor Detail

      • AbstractSubscriptionFolderBeanTransform

        public AbstractSubscriptionFolderBeanTransform()
        Default no-arg constructor, initialize formal parameters
    • Method Detail

      • isEmpty

        protected boolean isEmpty()
        Since:
        MicroStrategy Web 8.1.1
      • getImageTooltip

        protected java.lang.String getImageTooltip​(WebObjectInfo object)
        Since:
        MicroStrategy Web 8.0.2
      • renderEmptyList

        public abstract void renderEmptyList​(MarkupOutput out)
        renders an empty list
        Parameters:
        out - output by this transform
      • renderList

        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.
      • checkLevel

        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
      • getFieldCount

        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
      • renderImage

        public void renderImage​(MarkupOutput out,
                                java.lang.String image,
                                java.lang.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.
        Since:
        MicroStrategy Web 7.5.0
      • renderImage

        public void renderImage​(MarkupOutput out,
                                java.lang.String image)
        Renders a transform's image
        Overrides:
        renderImage in class AbstractAppTransform
        Parameters:
        out - where to write the output of the method.
        image - the image name
      • renderFooter

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

        protected void renderSort​(MarkupOutput out,
                                  int field)
      • isDisplayInfoAvailable

        protected boolean isDisplayInfoAvailable​(WebObjectInfo target)
        Since:
        MicroStrategy Web 8.0.0
      • getSubscriptionFolderBean

        public SubscriptionFolderBean getSubscriptionFolderBean()
        Returns:
        the bean being transformed.
      • getPreferenceValue

        public java.lang.String getPreferenceValue​(java.lang.String preferenceName)
        Description copied from class: AbstractAppTransform
        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.
        Overrides:
        getPreferenceValue in class AbstractAppTransform
        Parameters:
        preferenceName - name of the preference
        Returns:
        the bean being transformed.
        Since:
        MicroStrategy Web 7.5.0
      • renderSubscriptionsByDeliveryMode

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

        public boolean shouldShowSubscriptionsList​(int delMode)
      • renderPersonalViewSubscriptions

        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
        mode - int containing delivery mode from EnumDSSXMLSubscriptionDeliveryType
        Since:
        MicroStrategy Web 9.0.0
      • shouldShowPersonalViewSubscriptionsList

        public boolean shouldShowPersonalViewSubscriptionsList​(boolean isPublic)
      • hasSubscriptions

        public boolean hasSubscriptions()
      • renderShowMessage

        public void renderShowMessage​(MarkupOutput out)