Package com.microstrategy.web.app.beans

Interface EnumSaveAsEvents

  • public interface EnumSaveAsEvents
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • WebEventSelectSaveAsObjectType

        static final int WebEventSelectSaveAsObjectType
        Event to set the object type we need to save the report as. The object type can be either Report or Filter or Template.
        See Also:
        Constant Field Values

      • WebEventSelectSaveAsSysFolder

        static final int WebEventSelectSaveAsSysFolder
        Event to set the named folder under which we need to save the object. The named folders could be any of Shared Reports/My Reports/My Objects/Shared Templates/Shared Filters. Once the user selects a particular named folder he would be browse objects under that particular named folder and save the object any where under that folder provided the user has the permissions to do so.
        See Also:
        Constant Field Values

      • WebEventReportSaveAs

        static final int WebEventReportSaveAs
        Event to save the Report or Filter or Template in the metadata
        See Also:
        Constant Field Values

      • WebEventSetSaveAsBeanState

        static final int WebEventSetSaveAsBeanState
        Event to set the state of the save as bean before going to teh SaveAs page. This event is executed when the user clicks on the Save As link on the report page. It sets the parent folder ID of the report to be saved on the SaveAs bean so that we can open the folder browser on the SaveAs page with that folderID. It also sets the origin of the save event to be either from the report page or from any of the subscription actions. It also checks if the changes are to be applied to the report bean before being saved. This is particularly done when coming from the design mode page.
        See Also:
        Constant Field Values

      • WebEventReportWriterSaveAs

        static final int WebEventReportWriterSaveAs
        Event to save the ReportWriter object in the metadata
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventSelectSaveAsFolder

        static final int WebEventSelectSaveAsFolder
        Event to set the folder under which we need to save the object. The argument specifying the folder information will include either the named folder information or its identifier. The named folders could be any of Shared Reports/My Reports/My Objects/Shared Templates/Shared Filters. Once the user selects a particular named folder he would be browse objects under that particular named folder and save the object any where under that folder provided the user has the permissions to do so.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveAsSysFolder

        static final int WebEventArgumentSaveAsSysFolder
        Argument to indicate the named folder under which we need to save the object. The named folders could be any of Shared Reports/My Reports/My Objects/Shared Templates/Shared Filters.
        It can have a value from EnumDSSXMLFolderNames
        See Also:
        Constant Field Values

      • WebEventArgumentSaveAsReportName

        static final int WebEventArgumentSaveAsReportName
        Argument to specify the name of the new report/filter/template to be saved.
        See Also:
        Constant Field Values

      • WebEventArgumentSaveAsReportDescription

        static final int WebEventArgumentSaveAsReportDescription
        Argument to specify the description of the new report/filter/template to be saved.
        See Also:
        Constant Field Values

      • WebEventArgumentSaveAsReportSaveAsFlags

        static final int WebEventArgumentSaveAsReportSaveAsFlags
        Argument to specify the save as flags for the new report/filter/template. It can have a value from EnumDSSXMLReportSaveAsFlags
        See Also:
        Constant Field Values

      • WebEventArgumentSaveAsReportParentFolderID

        static final int WebEventArgumentSaveAsReportParentFolderID
        Argument to specify the folder ID under which the new object is to be saved.
        See Also:
        Constant Field Values

      • WebEventArgumentSaveEmbedded

        static final int WebEventArgumentSaveEmbedded
        Argument to specify if the filter and template definition is to be embedded in the report definition. Any not null value will indicate a true for this argument.
        See Also:
        Constant Field Values

      • WebEventArgumentSaveAsOverwrite

        static final int WebEventArgumentSaveAsOverwrite
        Argument to specify if the object should be over written if it already exists. This argument value has to be set to "1" to indicate true.
        See Also:
        Constant Field Values

      • WebEventArgumentSaveAsModify

        static final int WebEventArgumentSaveAsModify
        Argument to specify if the object should be modified if it already exists. This argument value has to be set to "1" to indicate true.
        See Also:
        Constant Field Values

      • WebEventArgumentSaveModificationsToReportFilter

        static final int WebEventArgumentSaveModificationsToReportFilter
        Argument to specify if we want to save modifications with report filter. Any not null value will indicate a true for this argument.
        See Also:
        Constant Field Values

      • WebEventArgumentApplyChangesFirst

        static final int WebEventArgumentApplyChangesFirst
        Argument to decide whether or not to apply changes to the Report Bean before going to the save as page. Typically this argument would be set to true if we are calling the save action from the report design mode page. The value of this argument has to be set to "true" to indicate a true.
        See Also:
        Constant Field Values

      • WebEventArgumentShowContinueButton

        static final int WebEventArgumentShowContinueButton
        Argument to specify if we need to show the continue button on the save as confirmation page after a save action. By default we will be showing the continue button. Only if this value is false we will not show the continue button
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • WebEventArgumentSaveAsFolder

        static final int WebEventArgumentSaveAsFolder
        Argument to indicate the folder under which we need to save the object. The value will be either the named folder information or its identifier, separated by a |. The named folders could be any of Shared Reports/My Reports/My Objects/Shared Templates/Shared Filters.
        It can have a value from EnumDSSXMLFolderNames
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveSimpleKeepPrompt

        static final int WebEventArgumentSaveSimpleKeepPrompt
        Argument to specify if we need to save the report as pormpted or not pormpted. This option is available on the simple options for the save page and is for DHTML mode only. The value of this option depends on what the user chooses for the prompt options on the advanced options.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveSimpleKeepLinked

        static final int WebEventArgumentSaveSimpleKeepLinked
        Argument to specify if we need to save the filter and template as linked objects to the report. This option is available on the simple options for the save page and is for DHTML mode only. The value of this option depends on what the user chooses for the embed filter template options on the advanced options.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveAdvKeepPrompt

        static final int WebEventArgumentSaveAdvKeepPrompt
        Argument to specify if we need to save the report as pormpted or not pormpted. This option is available on the advanced options for the save page.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveAdvFltTempPromptOptions

        static final int WebEventArgumentSaveAdvFltTempPromptOptions
        Argument to specify if we need to save the prompt on the filter or template or both for a prompted report. This option is available on the advanced options for the save page.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveKeepFilterManipulations

        static final int WebEventArgumentSaveKeepFilterManipulations
        Argument to specify if we need to save the filter manipulations for a prompted report. This option is available on the advanced options for the save page.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveKeepPromptAnswers

        static final int WebEventArgumentSaveKeepPromptAnswers
        Argument to specify if we need to keep the prompt answers for a prompted report. This option is available on the advanced options for the save page
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveKeepTemplateShortcuts

        static final int WebEventArgumentSaveKeepTemplateShortcuts
        Argument to specify if we need to keep the shortcuts to a template or embed them in the report. This option is available on the advanced options for the save page.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveKeepFilterShortcuts

        static final int WebEventArgumentSaveKeepFilterShortcuts
        Argument to specify if we need to keep the shortcuts to a filter or embed them in the report. This option is available on the advanced options for the save page.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveShowOptions

        static final int WebEventArgumentSaveShowOptions
        Argument to specify if the options related to prompts and embedded filter and template are rendered. If the options are not shown we will use the flags value as specified by the argument WebEventArgumentSaveAsReportSaveAsFlags.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveEmbedModifiedObjects

        static final int WebEventArgumentSaveEmbedModifiedObjects
        Argument to specify if if we want to embed the objects modified due to a linked filter or template. If this argument is not present we will change the linked filter and or template.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveChangeLinkedObjects

        static final int WebEventArgumentSaveChangeLinkedObjects
        Argument to specify if if we want to change the objects modified due to a linked filter or template. If this argument is not present we will embed the linked filter and or template.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentSaveFromDesignMode

        static final int WebEventArgumentSaveFromDesignMode
        Argument to specify if we save from design mode. If this argument is not present we treate it as from non-design mode.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentOriginPath

        static final int WebEventArgumentOriginPath
        Argument to indicate the origin bean path in previous page. If save as is canceled, this bean path can be used to find original bean and invoke events on it.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentIsFromPrompt

        static final int WebEventArgumentIsFromPrompt
        A boolean argument to indicate whether we save from prompting stage. If this argument is missing, we treat it as false.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebEventArgumentCopyNameTranslations

        static final int WebEventArgumentCopyNameTranslations
        Argument to indicate whether to copy the non-primary name translations from report being edit.
        Since:
        MicroStrategy Web 9.3.1
        See Also:
        Constant Field Values

      • WebEventArgumentOriginTarget

        static final int WebEventArgumentOriginTarget
        Argument to specify the orgin target of the save as action. This argument helps to determine the page where we should go after the save action is successful. This is supposed to be provided when origin is SaveAsBean.SAVE_AS_OPEN_NEW. This is a string value which is a combination of a valid event id and its arguments.
        Since:
        MicroStrategy Web 9.5.0
        See Also:
        Constant Field Values