Package com.microstrategy.web.app.transforms

Class SaveAsReportTransform

    • Field Detail

      • showSaveAsOptions

        public FormalParameter showSaveAsOptions
        Flag to decide whether to show the save as options at all. If this flag is set to false, only then will we use all the other save as flag related formal parameters.

      • saveNonPromptedEmbedFilterEmbedTemplate

        public FormalParameter saveNonPromptedEmbedFilterEmbedTemplate
        Value of the save as flags for a non prompted report that defines whether filter and template are embedded or linked.
        This flag will be used only in case the flag to show the options (showSaveAsOptions) for saving a report are not shown.
        The value comes from EnumDSSXMLReportSaveAsFlags

      • saveNonPromptedEmbedFilterLinkedTempalte

        public FormalParameter saveNonPromptedEmbedFilterLinkedTempalte
        Deprecated.
        use saveNonPromptedEmbedFilterEmbedTemplate
        Value of the save as flags for a non prompted report with embedded or linked filter and linked template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

      • saveNonPromptedLinkedFilterEmbedTempalte

        public FormalParameter saveNonPromptedLinkedFilterEmbedTempalte
        Deprecated.
        use saveNonPromptedEmbedFilterEmbedTemplate
        Value of the save as flags for a non prompted report with linked filter and embedded template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

      • saveNonPromptedLinkedFilterLinkedTempalte

        public FormalParameter saveNonPromptedLinkedFilterLinkedTempalte
        Deprecated.
        use saveNonPromptedEmbedFilterEmbedTemplate
        Value of the save as flags for a non prompted report with linked filter and template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

      • savePromptedEmbedFilterEmbedTemplate

        public FormalParameter savePromptedEmbedFilterEmbedTemplate
        Value of the save as flags for a prompted report that defines whether filter and template are embedded or linked.
        This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.
        The value comes from EnumDSSXMLReportSaveAsFlags

      • savePromptedEmbedFilterLinkedTempalte

        public FormalParameter savePromptedEmbedFilterLinkedTempalte
        Deprecated.
        use savePromptedEmbedFilterEmbedTemplate
        Value of the save as flags for a prompted report with embedded filter and linked template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

      • savePromptedLinkedFilterEmbedTempalte

        public FormalParameter savePromptedLinkedFilterEmbedTempalte
        Deprecated.
        use savePromptedEmbedFilterEmbedTemplate
        Value of the save as flags for a prompted report with linked filter and embedded template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

      • savePromptedLinkedFilterLinkedTempalte

        public FormalParameter savePromptedLinkedFilterLinkedTempalte
        Deprecated.
        use savePromptedEmbedFilterEmbedTemplate
        Value of the save as flags for a prompted report with linked filter and template. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

      • savePromptedFilter

        public FormalParameter savePromptedFilter
        Value of the save as flags for saving a the filter of a prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

      • savePromptedTemplate

        public FormalParameter savePromptedTemplate
        Value of the save as flags for saving a the template of a prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

      • saveNonPromptedFilter

        public FormalParameter saveNonPromptedFilter
        Value of the save as flags for saving a the filter of a non prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

      • saveNonPromptedTemplate

        public FormalParameter saveNonPromptedTemplate
        Value of the save as flags for saving a the template of a non prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.

      • checkKeepPrompt

        public FormalParameter checkKeepPrompt
        In the case of a prompted report, indicates whether the simple option for keeping the reprot prompted is checked by default.
        Since:
        MicroStrategy Web 8.0.2

      • renderLinksAncestors

        public FormalParameter renderLinksAncestors
        This formal parameter controls whether we display the ancestors of the Folder links in the ancestor list.

      • FP_SHOW_SAVE_OPTIONS

        public static final java.lang.String FP_SHOW_SAVE_OPTIONS
        Constant for the name of the showSaveAsOptions Formal Parameter.
        See Also:
        showSaveAsOptions, Constant Field Values

      • FP_PROMPTED_FILTER

        public static final java.lang.String FP_PROMPTED_FILTER
        Constant for the name of the savePromptedFilter Formal Parameter.
        See Also:
        savePromptedFilter, Constant Field Values

      • FP_CHECK_KEEP_PROMPT

        public static final java.lang.String FP_CHECK_KEEP_PROMPT
        Constant for the name of the checkKeepPrompt Formal Parameter.
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        checkKeepPrompt, Constant Field Values

      • FP_RENDER_LINKS_ANCESTORS

        public static final java.lang.String FP_RENDER_LINKS_ANCESTORS
        Constant for the name of the renderLinksAncestors Formal Parameters.
        Since:
        MicroStrategy Web 9.0.1
        See Also:
        Constant Field Values

    • Constructor Detail

      • SaveAsReportTransform

        public SaveAsReportTransform()
        Default constructor. Initializes formal parameters.

    • Method Detail

      • getErrorMessage

        public java.lang.String getErrorMessage​(int errorCode,
                                        java.lang.String defaultMessage)
        Description copied from class: AbstractAppTransform
        Returns the error message for the transform, based on the exception. By default returns: 
         getDescriptor(640) + " " + getDescriptor(641) + "
        "; //Descriptors: Your request could not be processed due to a server error. | Please try again.  If the error persists, contact the server administrator.
        Overrides:
        getErrorMessage in class AbstractAppTransform
        Parameters:
        errorCode - The error code for which we need the error message
        defaultMessage - the default error message to be shown
        Returns:
        The error message.
        Since:
        MicroStrategy Web 8.0.1

      • renderAdvancedOptionsDialog

        public void renderAdvancedOptionsDialog​(MarkupOutput out)
        Generates the dialog for allowing the user to define advanced save as options calls renderAdvancedPromptOptions, renderLinkOptions and renderAdvancedCreateButtonBar for displaying the fields available to the user.
        Overrides:
        renderAdvancedOptionsDialog in class SaveAsTransform
        Parameters:
        out - MarkupOutput instance with the output by this transform

      • renderAdvancedCreateButtonBar

        public void renderAdvancedCreateButtonBar​(MarkupOutput out)
        Renders the HTML for displaying the button bar contents for the Advanced options dialog.
        Parameters:
        out - MarkupOutput instance with the output by this transform

      • renderLanguagesOptions

        public void renderLanguagesOptions​(MarkupOutput out)
        Renders the HTML for displaying the languages save as options.
        Parameters:
        out - MarkupOutput instance with the output by this transform

      • renderLinkOptions

        public void renderLinkOptions​(MarkupOutput out)
        Renders the HTML for displaying the linked filter template save as options.
        Parameters:
        out - MarkupOutput instance with the output by this transform

      • renderAdvancedPromptOptions

        public void renderAdvancedPromptOptions​(MarkupOutput out)
        Renders the HTML for displaying the advanced save as options. These options are especially linked with the prompt options.
        Parameters:
        out - MarkupOutput instance with the output by this transform

      • renderEditorContents

        public void renderEditorContents​(MarkupOutput out)
        Generates the dialog for allowing the user to save an object with a new name and description. Internally calls renderSaveAsTabs for displaying the fields available to the user.
        Overrides:
        renderEditorContents in class SaveAsTransform
        Parameters:
        out - MarkupOutput instance with the output by this transform

      • generateAncestorsOptionTags

        protected java.util.ArrayList generateAncestorsOptionTags()
        Generates the series of option tags to add to the combo box for showing the user the possible places where the new object can be saved, based on privileges, access rights and current location of the object.
        Overrides:
        generateAncestorsOptionTags in class SaveAsTransform
        Returns:
        an array of Tag instances corresponding to the different OPTION that will be provided to the user.

      • generateAnchor

        protected AnchorTag generateAnchor​(WebEvent event)
        Overwrites the parent method by setting default attribute information
        Overrides:
        generateAnchor in class SaveAsTransform
        Parameters:
        event - WebEvent instance to use as base for the link
        Returns:
        AnchorTag instance initialized with the event information

      • renderSaveAsTabs

        public void renderSaveAsTabs​(MarkupOutput out)
        This method renders the different tabs that enable the user to determine the object type to save, which can be either a new report, a filter or a template.
        Parameters:
        out - MarkupOutput instance with the output by this transform

      • renderSimpleOptions

        public void renderSimpleOptions​(MarkupOutput out)
        Renders save as options such as:
        • Keep report prompted
        • Keep template and filter as linked objects
        • Button for "Advanced Options..."
        Parameters:
        out - MarkupOutput instance with the output by this transform

      • renderOverwriteConfirmationDialog

        public void renderOverwriteConfirmationDialog​(MarkupOutput out)
                                       throws UnmodifiableException
        Renders the dialog that informs the user that the report being saved already exists and asks users if they wish to overwrite it.
        Throws:
        UnmodifiableException
        Since:
        MicroStrategy Web 8.0.2

      • renderModifyConfirmationDialog

        public void renderModifyConfirmationDialog​(MarkupOutput out)
                                    throws UnmodifiableException
        Renders the dialog that informs the user that the template and/or template have been modified and asks them if they want to link to the original object
        Throws:
        UnmodifiableException
        Since:
        MicroStrategy Web 8.0.2

      • renderOverwriteSaveFlags

        protected void renderOverwriteSaveFlags​(MarkupOutput out,
                                        WebEvent saveEvent)
        Render the save as flags as hidden inputs in case of an overwrite
        Parameters:
        out - MarkupOutput instance with the output by this transform
        saveEvent - The event used for saving

      • hasOtherNameTranslations

        protected boolean hasOtherNameTranslations()
        Determine if the target object to save has other name translations or not
        Returns:
        boolean value indicating if the target object to save has other name translations or not

      • isPrompted

        protected boolean isPrompted()
        Determine if the target object to save is prompted or not
        Returns:
        boolean value indicating if the object is prompted or not

      • isDisplaySaveEmbeddedCheckBox

        protected boolean isDisplaySaveEmbeddedCheckBox()
        Determine if the save embedded check box option should be rendered or not
        Returns:
        boolean value indicating if the check box should become available or not, based on privileges and if the target object is prompted or not.

      • getTargetTabEvent

        protected WebEvent getTargetTabEvent()
        Obtain an instance of the WebEvent to use for switching to the Report tab on the Save As dialog
        Returns:
        WebEvent instance initialized, null if it could not be created.

      • getFilterTabEvent

        protected WebEvent getFilterTabEvent()
        Obtain an instance of the WebEvent to use for switching to the Filter tab on the Save As dialog
        Returns:
        WebEvent instance initialized, null if it could not be created.

      • getTemplateTabEvent

        protected WebEvent getTemplateTabEvent()
        Obtain an instance of the WebEvent to use for switching to the Template tab on the Save As dialog
        Returns:
        WebEvent instance initialized, null if it could not be created.

      • getExecuteEvent

        protected WebEvent getExecuteEvent()
        Obtain an instance of the WebEvent to use for executing the object that has just been saved
        Returns:
        WebEvent instance initialized, null if it could not be created.

      • getObjectDescription

        protected java.lang.String getObjectDescription()
        Description copied from class: SaveAsTransform
        Obtain the object description to use for the new object to create
        Overrides:
        getObjectDescription in class SaveAsTransform
        Returns:
        String value with the description of the new object to be created. It can come from the original object or whatever the user might had previously specified for it.
        Since:
        MicroStrategy Web 9.0.0

      • shouldRenderOpenParent

        public boolean shouldRenderOpenParent()
        Checks whether we should render the open parent link. Will return false if the current folder is a link and renderLinksAncestors is false.

      • getConfirmationTitle

        public java.lang.String getConfirmationTitle()
        Return the confirmation title for the save as confirmation dialog
        Specified by:
        getConfirmationTitle in class SaveAsTransform
        Returns:
        The confirmation title for the save as confirmation dialog