Class AbstractSubscriptionEditTransform

    • Field Detail

      • PROMPTS_TRANSFORM_STYLE

        @Deprecated
        public java.lang.String PROMPTS_TRANSFORM_STYLE
        Deprecated.
        Please use the promptsTransformStyle Formal Parameter instead
      • FP_PROMPTS_TRANSFORM_STYLE

        public static final java.lang.String FP_PROMPTS_TRANSFORM_STYLE
        Name for the Formal parameter FP_PROMPTS_TRANSFORM_STYLE
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • FP_IMG_GRAPH

        public static final java.lang.String FP_IMG_GRAPH
        Name for the Formal parameter FP_IMG_GRAPH
        See Also:
        Constant Field Values
      • FP_IMG_GRID

        public static final java.lang.String FP_IMG_GRID
        Name for the Formal parameter FP_IMG_GRID
        See Also:
        Constant Field Values
      • FP_IMG_DATAMART

        public static final java.lang.String FP_IMG_DATAMART
        Name for the Formal parameter FP_IMG_DATAMART
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values
      • FP_IMG_GRID_GRAPH

        public static final java.lang.String FP_IMG_GRID_GRAPH
        Name for the Formal parameter FP_IMG_GRID_GRAPH
        See Also:
        Constant Field Values
      • FP_IMG_DOCUMENT

        public static final java.lang.String FP_IMG_DOCUMENT
        Name for the Formal parameter FP_IMG_DOCUMENT
        See Also:
        Constant Field Values
      • FP_IMG_RW_DOCUMENT

        public static final java.lang.String FP_IMG_RW_DOCUMENT
        Name for the Formal parameter FP_IMG_RW_DOCUMENT
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values
      • FP_FORM_ID

        public static final java.lang.String FP_FORM_ID
        Name for the Formal parameter FP_FORM_ID
        See Also:
        Constant Field Values
      • VIEW_MODE_GRID

        public final int VIEW_MODE_GRID
        One of the values for the View Mode property in this transform
        See Also:
        Constant Field Values
      • VIEW_MODE_GRAPH

        public final int VIEW_MODE_GRAPH
        One of the values for the View Mode property in this transform
        See Also:
        Constant Field Values
      • VIEW_MODE_GRID_GRAPH

        public final int VIEW_MODE_GRID_GRAPH
        One of the values for the View Mode property in this transform
        See Also:
        Constant Field Values
      • VIEW_MODE_DOCUMENT

        public final int VIEW_MODE_DOCUMENT
        One of the values for the View Mode property in this transform
        See Also:
        Constant Field Values
      • VIEW_MODE_RW_DOCUMENT

        public final int VIEW_MODE_RW_DOCUMENT
        One of the values for the View Mode property in this transform
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values
      • VIEW_MODE_DATAMART

        public final int VIEW_MODE_DATAMART
        One of the values for the View Mode property in this transform
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values
      • VIEW_MODE_CUBE

        public final int VIEW_MODE_CUBE
        One of the values for the View Mode property in this transform
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • VIEW_MODE_BULK_EXPORT

        public final int VIEW_MODE_BULK_EXPORT
        One of the values for the View Mode property in this transform
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values
      • SUBSCRIBE_FROM_SAVEAS

        public final java.lang.String SUBSCRIBE_FROM_SAVEAS
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values
      • promptsTransformStyle

        public FormalParameter promptsTransformStyle
        Name of the style to apply for rendering prompts on this transform.
        Since:
        MicroStrategy Web 8.0.0
      • graphImage

        @Deprecated
        public FormalParameter graphImage
        Deprecated.
        We no longer render the images when the user tries to edit/create a new subscription.
        Name of the image used to depict a subscription to a graph.
      • gridGraphImage

        @Deprecated
        public FormalParameter gridGraphImage
        Deprecated.
        We no longer render the images when the user tries to edit/create a new subscription.
        Name of the image used to depict a subscription to a grid-graph.
      • gridImage

        @Deprecated
        public FormalParameter gridImage
        Deprecated.
        We no longer render the images when the user tries to edit/create a new subscription.
        Name of the image used to depict a subscription to a grid.
      • datamartImage

        @Deprecated
        public FormalParameter datamartImage
        Deprecated.
        We no longer render the images when the user tries to edit/create a new subscription.
        Name of the image used to depict a subscription to a datamart.
        Since:
        MicroStrategy Web 7.5.0
      • documentImage

        @Deprecated
        public FormalParameter documentImage
        Deprecated.
        We no longer render the images when the user tries to edit/create a new subscription.
        Name of the image used to depict a subscription to a document.
      • rwDocumentImage

        @Deprecated
        public FormalParameter rwDocumentImage
        Deprecated.
        We no longer render the images when the user tries to edit/create a new subscription.
        Name of the image used to depict a subscription to a report writing document.
        Since:
        MicroStrategy Web 7.5.0
      • formID

        public FormalParameter formID
        The ID and the name to use for the subscriptions's HTML FORM tag.
      • helpType

        public FormalParameter helpType
        Indicates the type of help topic this editor uses.
        Since:
        MicroStrategy Web 9.0.0
      • helpTopic

        public FormalParameter helpTopic
        Indicates the help topic for the help page of the editor.
        Since:
        MicroStrategy Web 9.0.0
      • FP_HELP_TYPE

        public static final java.lang.String FP_HELP_TYPE
        Constant specifying the type of the help file this editor should point to
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • FP_HELP_TOPIC

        public static final java.lang.String FP_HELP_TOPIC
        Constant specifying the name of the formal parameter for specifying the help topic for the help of the editor
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • _helpTopic

        protected java.lang.String _helpTopic
        Since:
        MicroStrategy Web 9.0.0
      • _helpType

        protected java.lang.String _helpType
        Since:
        MicroStrategy Web 9.0.0
    • Constructor Detail

      • AbstractSubscriptionEditTransform

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

      • getUpdatePropertiesEvent

        protected abstract WebEvent getUpdatePropertiesEvent()
        Since:
        MicroStrategy Web 9.0.0
      • getPersonalizationLinkEvent

        protected abstract WebEvent getPersonalizationLinkEvent()
        Since:
        MicroStrategy Web 9.0.0
      • initHelp

        protected void initHelp()
        Since:
        MicroStrategy Web 9.0.0
      • renderFormStart

        public void renderFormStart​(MarkupOutput out,
                                    boolean hasOpenPrompts)
        Renders the FORM start tag.
        Parameters:
        out - Output by this transform.
        hasOpenPrompts - true if there are open prompts in this subscription.
      • renderFormEnd

        public void renderFormEnd​(MarkupOutput out,
                                  boolean hasOpenPrompts)
        Renders the FORM end tag.
        Parameters:
        out - Output by this transform
        hasOpenPrompts - true if there are open prompts in this subscription.
      • renderIconPane

        @Deprecated
        public void renderIconPane​(MarkupOutput out)
        Deprecated.
        We no longer render the images when the user tries to edit/create a new subscription.
        Renders The icon pane, based on the view mode
        Parameters:
        out - the transform's output.
      • getPromptsTransform

        protected TransformInstance getPromptsTransform​(PromptsBean promptsBean)
        Return the transform instance associated with the promptsBean. If the Formal Parameter FP_PROMPTS_TRANSFORM_STYLE is set, it will add that style to the bean and return the transform instance. If not, it will return a new instance of PromptsSubscriptionTransform.
        Parameters:
        promptsBean - the prompts bean to transform
        Returns:
        the Transform Instance.
        Since:
        MicroStrategy Web 8.0.0
      • renderPrompts

        public void renderPrompts​(MarkupOutput out)
        Render the prompts content.
        It just ask the prompts bean to transform itself using the PROMPTS_TRANSFORM_STYLE style.
        Parameters:
        out - the transform's output.
      • renderExecuteButtons

        public void renderExecuteButtons​(MarkupOutput out)
        Render the execute buttons (Ok-Cancel)
        Parameters:
        out - The transform's output.
      • getDivButtonBar

        protected Tag getDivButtonBar()
        Since:
        MicroStrategy Web 9.0.0
      • renderSchedulePane

        public abstract void renderSchedulePane​(MarkupOutput out)
        Renders the pane containing the list of schedules
        Parameters:
        out - The transform's output.
      • renderImage

        public void renderImage​(MarkupOutput out,
                                java.lang.String image)
        Renders an image for this transform
        Overrides:
        renderImage in class AbstractAppTransform
        Parameters:
        out - The transform's output.
        image - The image name
      • initializeTransform

        public void initializeTransform​(Transformable data)
        Extends initializeTransform by keeping its own copy of the data. This method initializes the private and protected fields of the transform. It also invokes the initializeTransform method of the parent.
        Specified by:
        initializeTransform in interface AppTransform
        Overrides:
        initializeTransform in class AbstractAppTransform
        Parameters:
        data - the bean to transform.
        Since:
        MicroStrategy Web 8.0.1
      • getPromptsEvent

        public WebEvent getPromptsEvent()
        The event to answer prompts.
        Returns:
        The EnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ALL_PROMPTS event.
      • supports

        public boolean supports​(java.lang.Class type)
        Overwrites supports by only supporting Subscription and Schedule Beans.
        Specified by:
        supports in interface Transform
        Overrides:
        supports in class AbstractTransform
        Parameters:
        type - The bean type.
        Returns:
        true if bean is assignable to a SubscriptionBean or ScheduleBean
      • getTitle

        public java.lang.String getTitle()
        Title for the dialog
        Returns:
        the title to be displayed.
        Since:
        MicroStrategy Web 8.0.0
      • isRWD

        public boolean isRWD()
        Determine whether the current object is a RW Document
        Returns:
        true if the document is a RW Document
        Since:
        MicroStrategy Web 8.0.0
      • isSubscriptionFromSaveAs

        public boolean isSubscriptionFromSaveAs()
        Returns whether the subscription was triggered from the Save As page.
        Returns:
        boolean
        Since:
        MicroStrategy Web 8.0.1
      • setSubscribeFromSaveAs

        public void setSubscribeFromSaveAs​(boolean subscribeFromSaveAs)
        Sets the value of the SubscribeFromSaveAs from the request to a property of the transform
        Parameters:
        subscribeFromSaveAs - boolean
        Since:
        MicroStrategy Web 8.0.1
      • getViewMode

        public abstract int getViewMode()
        The schedule or subscription view mode. Possible values are VIEW_MODE_GRID, VIEW_MODE_GRAPH, VIEW_MODE_GRID_GRAPH or VIEW_MODE_DOCUMENT.
        Returns:
        The view mode of the schedule.
      • getAddEvent

        public abstract WebEvent getAddEvent()
        Event to create a new subscription or schedule.
        Returns:
        The event to create a new subscription.
      • getAddressEvent

        public WebEvent getAddressEvent()
        The event to open the Narrowcast address page.
        Returns:
        This method always returns null.
      • getCancelEvent

        public abstract WebEvent getCancelEvent()
        The event to cancel the subscription or schedule.
        Overrides:
        getCancelEvent in class AbstractAppTransform
        Returns:
        The event to cancel the subscription
      • getReturnEvent

        public abstract WebEvent getReturnEvent()
        The event to execute if the the subscription or schedule is created successfully.
        Returns:
        The event to execute once the Subscription has been created succesfully
      • getPromptsBean

        public abstract PromptsBean getPromptsBean()
        Return the prompts bean associated with the SubscriptionBean or ScheduleBean
        Returns:
        the PromptsBean associated with the SubscriptionBean or ScheduleBean
      • getAvailableTriggers

        public abstract SimpleList getAvailableTriggers()
        List of available triggers.
        Returns:
        The list of Available triggers. Based on whether we are rendering subscriptions or schedules, this method will either return the list of available triggers for subscriptions or schedules.