Class SubscriptionEditTransform

    • Field Detail

      • _subscriptionBean

        protected SubscriptionBean _subscriptionBean
        MicroStrategy Web 8.0.0
      • _addEvent

        protected WebEvent _addEvent
        The event for the creating the subscription
      • _updatePropertiesEvent

        protected WebEvent _updatePropertiesEvent
        MicroStrategy Web 9.0.0
      • _personalizationLinkEvent

        protected WebEvent _personalizationLinkEvent
        MicroStrategy Web 9.0.0
      • _cancelEvent

        protected WebEvent _cancelEvent
        The event for the canceling the current action
      • _returnEvent

        protected WebEvent _returnEvent
        The event for the returning to the previous state
      • _allowSubscription

        protected boolean _allowSubscription
        MicroStrategy Web 7.5.0
      • _isUserAllowedToSubscribe

        protected boolean _isUserAllowedToSubscribe
      • subscribeGraphAsGridGraph

        public FormalParameter subscribeGraphAsGridGraph
        Indicates if graphs are to be subscribed as grid-graph. If we are subscribing to a graph and this proerty is set to true, then we will create a subscription for a grid-grah rather than a graph. This property is usually mapped to a graph preference which indicates if we want to run all graphs as grid-graphs.
        If this formal parameter is set to "1", it will be treated as true.
      • _subscribeGraphAsGridGraph

        protected java.lang.String _subscribeGraphAsGridGraph
        The boolean value to indicate if graphs are to be subscribed as grid-graph.

        public static final java.lang.String FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH
        Name for the formal parameter FP_SUBSCRIBE_GRAPH_AS_GRIDGRAPH
        See Also:
        Constant Field Values
    • Constructor Detail

      • SubscriptionEditTransform

        public SubscriptionEditTransform()
        Default no argument constructor, initialize formal parameters.
    • Method Detail

      • renderJobExpiredSection

        public void renderJobExpiredSection​(MarkupOutput out)
        Renders the job expired section, including an error message and an reexecute button
        out - Output by this transform
        MicroStrategy Web 8.0.1
      • renderShell

        public void renderShell​(MarkupOutput out)
        Description copied from class: AbstractAppTransform

        Generates the shell for this Transform.

        The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

        The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
        This method calls renderCssLink and checkStatus to generate the Transform's content.
        renderShell in class AbstractAppTransform
        out - output by this transform
      • renderSchedulePane

        public void renderSchedulePane​(MarkupOutput out)
        Renders the schedule pane for the user to subscribe to a report or document. It uses an instance of the SubscriptionWidget for this purpose.
        Specified by:
        renderSchedulePane in class AbstractSubscriptionEditTransform
        out - Output by this transform.
      • initWidget

        protected void initWidget​( widget,
                                  WebEvent addEvent)
                           throws WebBeanException
        MicroStrategy Web 9.0.0
      • setExpandPageByProperties

        protected void setExpandPageByProperties​( widget,
                                                 WebEvent addEvent)
        widget - SubscriptionWidget
        addEvent - WebEvent
        MicroStrategy Web 8.0.0
      • setExpandLayoutProperties

        protected void setExpandLayoutProperties​( widget,
                                                 WebEvent addEvent)
        MicroStrategy Web 9.0.0
      • getSubscriptionWidget

        public getSubscriptionWidget()
        The subscription widget used to render the subscription pane.
        A SubscriptionWidget instance.
      • getViewMode

        public int getViewMode()
        The subscription view mode. Possible values are VIEW_MODE_GRID, VIEW_MODE_GRAPH, VIEW_MODE_GRID_GRAPH or VIEW_MODE_DOCUMENT.
        Specified by:
        getViewMode in class AbstractSubscriptionEditTransform
        The view mode of the subscription.
      • getCurrentFormat

        public WebSubscriptionContentFormat getCurrentFormat()
        Returns the current format for this subscription used when creating the subscription. This could be HTML or EXCEL or PDF or any other such format.
        The current subscription format.
      • getDescription

        public java.lang.String getDescription()
        Returns the description of this transform. This is used in the style catalog editor.
        The description of this transform.
      • getReturnEvent

        public WebEvent getReturnEvent()
        The event to trigger after the subscription is saved correctly.
        Specified by:
        getReturnEvent in class AbstractSubscriptionEditTransform
        By default, the EnumServletEvents.WebEventCancel event, however if coming from the SaveAs page, it returns the EnumServletEvents.WebEventOpenObjectSubscriptions, to go to the list of subscriptions.
      • getSubscriptionBean

        protected SubscriptionBean getSubscriptionBean()
        Return the the SubscriptionBean that this transform is going to transform.
        A SubscriptionBean instance
        MicroStrategy Web 7.5.1