Package com.microstrategy.web.app.beans

Interface SaveAsBean

    • Field Detail

      • SAVE_AS_FROM_REPORT

        static final java.lang.String SAVE_AS_FROM_REPORT
        Indicates that we came to the save page from the report page. For more information @see SaveAsBean#getSaveAsOrigin()
        See Also:
        Constant Field Values

      • SAVE_AS_NC_SUBSCRIPTIONS

        static final java.lang.String SAVE_AS_NC_SUBSCRIPTIONS
        Indicates that we came to the save page while creating an email subscription. For more information @see SaveAsBean#getSaveAsOrigin()
        See Also:
        Constant Field Values

      • SAVE_AS_NC_SENDNOW

        static final java.lang.String SAVE_AS_NC_SENDNOW
        Indicates that we came to the save page while creating a send now subscription. For more information @see SaveAsBean#getSaveAsOrigin()
        See Also:
        Constant Field Values

      • SAVE_AS_WEB_SCHEDULING

        static final java.lang.String SAVE_AS_WEB_SCHEDULING
        Indicates that we came to the save page while creating a web subscription. For more information @see SaveAsBean#getSaveAsOrigin()
        See Also:
        Constant Field Values

      • SAVE_AS_NC_FILE_SUBSCRIPTIONS

        static final java.lang.String SAVE_AS_NC_FILE_SUBSCRIPTIONS
        Indicates that we came to the save page while creating a file subscription. For more information @see SaveAsBean#getSaveAsOrigin()
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • SAVE_AS_NC_PRINT_SUBSCRIPTIONS

        static final java.lang.String SAVE_AS_NC_PRINT_SUBSCRIPTIONS
        Indicates that we came to the save page while creating a print subscription. For more information @see SaveAsBean#getSaveAsOrigin()
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • SAVE_AS_WEB_MOBILE_SCHEDULING

        static final java.lang.String SAVE_AS_WEB_MOBILE_SCHEDULING
        Indicates that we came to the save page while creating a mobile subscription. For more information @see SaveAsBean#getSaveAsOrigin()
        Since:
        MicroStrategy Web 8.1.1
        See Also:
        Constant Field Values

      • SAVE_AS_CONVERT_DOCUMENT

        static final java.lang.String SAVE_AS_CONVERT_DOCUMENT
        Indicates that we came to the save page while creating a document from a report and the report needs to be saved before being converted to a document. For more information @see SaveAsBean#getSaveAsOrigin()
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • SAVE_AS_WEB_ALERT

        static final java.lang.String SAVE_AS_WEB_ALERT
        Indicates that we came to the save page while creating an email notification. For more information @see SaveAsBean#getSaveAsOrigin()
        Since:
        MicroStrategy Web 9.0.1
        See Also:
        Constant Field Values

      • SAVE_AS_WEB_ALERT_MOBILE

        static final java.lang.String SAVE_AS_WEB_ALERT_MOBILE
        Indicates that we came to the save page while creating a mobile notification. For more information @see SaveAsBean#getSaveAsOrigin()
        Since:
        MicroStrategy Web 9.0.1
        See Also:
        Constant Field Values

      • SAVE_AS_PERSONAL_VIEW

        static final java.lang.String SAVE_AS_PERSONAL_VIEW
        See Also:
        Constant Field Values

      • SAVE_AS_SHARE_EDITOR

        static final java.lang.String SAVE_AS_SHARE_EDITOR
        Indicates that we came to the save page from share editor. More information @see SaveAsBean#getSaveAsOrigin()
        Since:
        MicroStrategy Web 9.3.1
        See Also:
        Constant Field Values

      • SAVE_AS_EXPORT_AS_MSTR

        static final java.lang.String SAVE_AS_EXPORT_AS_MSTR
        Indicates that we came to the save page while exporting as mstr. More information @see SaveAsBean#getSaveAsOrigin()
        See Also:
        Constant Field Values

      • SAVE_AS_NC_FTP_SUBSCRIPTIONS

        static final java.lang.String SAVE_AS_NC_FTP_SUBSCRIPTIONS
        Indicates that we came to the save page while creating a printFTP subscription. For more information @see SaveAsBean#getSaveAsOrigin()
        Since:
        MicroStrategy Web 9.5.0
        See Also:
        Constant Field Values

      • SAVE_AS_OPEN_NEW

        static final java.lang.String SAVE_AS_OPEN_NEW
        Indicates that we came to the save page while opening a new report/document. For more information @see SaveAsBean#getSaveAsOrigin()
        Since:
        MicroStrategy Web 9.5.0
        See Also:
        Constant Field Values

      • SAVE_AS_EXPORT_MSTR

        static final java.lang.String SAVE_AS_EXPORT_MSTR
        Indicates that we came to the save page while exporting dashboard to .mstr file. For more information @see SaveAsBean#getSaveAsOrigin()
        Since:
        MicroStrategy Web 9.5.0
        See Also:
        Constant Field Values

      • SAVE_AS_CONVERT_ANALYSIS

        static final java.lang.String SAVE_AS_CONVERT_ANALYSIS
        Indicates that we came to the save page while creating a Flash dashboard.
        See Also:
        Constant Field Values

      • SAVE_AS_CONVERT_HTML5_ANALYSIS

        static final java.lang.String SAVE_AS_CONVERT_HTML5_ANALYSIS
        Indicates that we came to the save page while creating an Html5 dashboard.
        See Also:
        Constant Field Values

      • SAVE_AS_NC_CACHE_CUBE_UPDATE

        static final java.lang.String SAVE_AS_NC_CACHE_CUBE_UPDATE
        Indicates that we came to the save page while creating an cache/cube update subscription. For more information @see SaveAsBean#getSaveAsOrigin()
        See Also:
        Constant Field Values

    • Method Detail

      • getSaveAsObjectType

        java.lang.String getSaveAsObjectType()
        Returns the selected tab. The format you want to save the report as. It can be report, filter or template. The value is from the EnumDSSXMLObjectTypes enumeration.
        Returns:
        The object type of the object to be saved. It can be report, filter or template.

      • getSaveAsOrigin

        java.lang.String getSaveAsOrigin()
        Returns the string which indicates as to where have we come to the save as page from. If it is from any of the subsciriptions (web or email) we need to go back there after the save action. This is required because there are some report manipulations which require the user to save the report first before they can subscribe to it. If it is from the document creation from report action, we need to open the converted document from the saved report after the save action on the report is completed. If such a case arises, we need to go back to the place from where the save was initiated.
        Returns:
        The value which depicts as to the place from where the save action was originated from.

      • getSaveAsOriginPath

        java.lang.String getSaveAsOriginPath()
        Returns the origin bean path in previous page where we come to this save as page. When save as page is canceled, we will be taken back to the previous page. With the information about the original bean path, it make it possible to invoke events on previous page. We are using this bean path to invoke re-prompt event on origin bean, when the save as page is canceled.
        Since:
        MicroStrategy Web 9.0.0

      • setSaveAsOriginPath

        void setSaveAsOriginPath​(java.lang.String path)
        Sets the origin bean path in previous page where we come to this save as page.
        Parameters:
        path -
        Since:
        MicroStrategy Web 9.0.0

      • getIsFromPrompt

        boolean getIsFromPrompt()
        Returns whether the save as bean comes from a page which was waiting from user input.
        Returns:
        Returns true when we come from a prompting page. Default value is false.
        Since:
        MicroStrategy Web 9.0.0

      • setIsFromPrompt

        void setIsFromPrompt​(boolean prompt)
        Sets this flag to indicate whether we come here from waiting for user input. Save as bean may behave differently based on this flag. For example, when save procedure canceled, save as bean may return the previous page and reopen those prompts.
        Parameters:
        prompt - true means we come from a prompting page, otherwise false.
        Since:
        MicroStrategy Web 9.0.0

      • getShowContinueBtn

        boolean getShowContinueBtn()
        Returns the boolean which indicates whether the Continue button for the Original Report should be displayed.
        Returns:
        The value which indicates whether the Continue button for the Original Report should be displayed.
        Since:
        MicroStrategy Web 7.5.1

      • setShowContinueBtn

        void setShowContinueBtn​(boolean value)
        Sets the boolean which indicates whether the Continue button for the Original Report should be displayed.
        Parameters:
        value - The value which indicates whether the Continue button for the Original Report should be displayed.
        Since:
        MicroStrategy Web 7.5.1

      • setSaveAsOrigin

        void setSaveAsOrigin​(java.lang.String value)
        Sets the string which indicates as to where have we come to the save as page from. If it is from any of the subsciriptions (web or email) we need to go back there after the save action. This is required because there are some report manipulations which require the user to save the report first before they can subscribe to it. If such a case arises, we need to go back to the place from where the save was initiated.
        Parameters:
        value - The value which indicates the origin of the save as action.

      • getSaveAsObjectSaved

        boolean getSaveAsObjectSaved()
        Returns true if the object is saved successfully.
        Returns:
        true if the object is saved successfully.

      • getSaveAsObjectDuplicate

        boolean getSaveAsObjectDuplicate()
        Returns true if the object that you are trying to save already exists in the location you are trying to save with the same type that you are trying to save.
        Returns:
        true if the object already exists.

      • getSaveAs8iWarning

        boolean getSaveAs8iWarning()
        Returns true if you are trying to save a 7i report with a new 8i OLAP services report.
        Returns:
        true if you are trying to save a 7i report with a new 8i OLAP services report.
        Since:
        MicroStrategy Web 8.0.0

      • getSaveAsObjectModified

        boolean getSaveAsObjectModified()
        Returns true if the object you are saving modifies some of the linked objects. This could happen if you change a report filter and the then save the report which in turn modifies and saves the embedded filter in the report.
        Returns:
        true if the object save causes some of the embedded objects to get modified.

      • getSaveAsEmbedModifiedObjects

        boolean getSaveAsEmbedModifiedObjects()
        Returns true if you want to embed the modified objects. This will be the case when the object you are saving modifies some of the linked objects.
        Returns:
        true if you want to embed the modified objects.
        Since:
        MicroStrategy Web 8.0.0

      • getSaveAsChangeLinkedObjects

        boolean getSaveAsChangeLinkedObjects()
        Returns true if you want to change the linked objects. This will be the case when the object you are saving modifies some of the linked objects.
        Returns:
        true if you want to change linked objects.
        Since:
        MicroStrategy Web 8.0.0

      • getSaveAsNewReportID

        java.lang.String getSaveAsNewReportID()
        Returns the report Id of the newly saved saved report.
        Returns:
        The report ID of the newly saved report.

      • getSaveAsNewReportName

        java.lang.String getSaveAsNewReportName()
        Returns the report name of the newly saved saved report.
        Returns:
        The report name of the newly saved report.

      • getParentFolderID

        java.lang.String getParentFolderID()
        Returns the parent folder ID of the report to be saved.
        Returns:
        Parent folder ID of the report to be saved.

      • setSaveAsObjectType

        void setSaveAsObjectType​(java.lang.String saveAsObjectType)
        Sets the selected tab. The format you want to save the report as. This can be report, filter or template. The value is from the EnumDSSXMLObjectTypes enumeration.
        Parameters:
        saveAsObjectType - The type of the object that you want to save the report as. It can be report, filter or template.

      • setSaveAsObjectSaved

        void setSaveAsObjectSaved​(boolean objectSaved)
        Sets the Object Saved flag to true if the object is saved successfully.
        Parameters:
        objectSaved - Boolean value to indicate if the object is saved successfully.

      • setSaveAsObjectDuplicate

        void setSaveAsObjectDuplicate​(boolean objectDuplicate)
        Sets the Object Duplicate flag to true if the object already exists.
        Parameters:
        objectDuplicate - Set this to true if the object being saved already exists at the same location.

      • setSaveAs8iWarning

        void setSaveAs8iWarning​(boolean object8iWarning)
        Sets the flag to true 8i warning flag to true if you are trying to save a 7i report with a new 8i OLAP services report.
        Parameters:
        object8iWarning - Set this to true if trying to oevrwrite old 7i report with new 8i report.
        Since:
        MicroStrategy Web 8.0.0

      • setSaveAsObjectModified

        void setSaveAsObjectModified​(boolean objectModified)
        Sets the Object Modified flag to true if one or more of the embedded objects of the report are being modified as a result of the save.
        Parameters:
        objectModified - Boolean flag which indicates if one or more objects are getting modified as a result of the save.

      • setSaveAsEmbedModifiedObjects

        void setSaveAsEmbedModifiedObjects​(boolean embedModifiedObject)
        Set to true if you want to embed the modified objects. This will be the case when the object you are saving modifies some of the linked objects.
        Parameters:
        embedModifiedObject - Boolean flag set to true if you want to embed the modified objects.
        Since:
        MicroStrategy Web 8.0.0

      • setSaveAsChangeLinkedObjects

        void setSaveAsChangeLinkedObjects​(boolean changeLinkedObject)
        Set to true if you want to change the linked objects. This will be the case when the object you are saving modifies some of the linked objects.
        Parameters:
        changeLinkedObject - Boolean flag set to true if you want to change linked objects.
        Since:
        MicroStrategy Web 8.0.0

      • setSaveAsNewReportID

        void setSaveAsNewReportID​(java.lang.String saveAsReportID)
        Sets the report Id of the newly saved report.
        Parameters:
        saveAsReportID - The ID of the newly saved report.

      • setSaveAsNewReportName

        void setSaveAsNewReportName​(java.lang.String saveAsReportName)
        Sets the report name of the newly saved report.
        Parameters:
        saveAsReportName - The name of the newly saved report.

      • setParentFolderID

        void setParentFolderID​(java.lang.String parentFolderID)
        Sets the parent folderID of the report to be saved. This is the folder to which the folder browser on the save as page will default to.
        Parameters:
        parentFolderID - The folder ID to which the report which is being saved belongs to.

      • getXMLStatus

        int getXMLStatus()
        Returns the EnumRequestStatus status of the bean. By default the status of this bean is WebBeanRequestWaitingForUserInput.
        Specified by:
        getXMLStatus in interface WebComponent
        Returns:
        The EnumRequestStatus of the component.

      • setXMLStatus

        void setXMLStatus​(int value)
        Sets the EnumRequestStatus status of the bean. By default the status of this bean is WebBeanRequestWaitingForUserInput.
        Parameters:
        value - The XML status value ofor this bean.

      • getReportBean

        ReportBean getReportBean()
        Returns the report bean among the children of the save as bean.
        Returns:
        The report bean among the children of the save as bean.

      • getFolderBean

        FolderBean getFolderBean()
        Returns the folder bean among the children of the save as bean.
        Specified by:
        getFolderBean in interface FolderObjectExplorerBean
        Returns:
        The folder bean among the children of the save as bean.

      • getReportYahooPathStyle

        java.lang.String getReportYahooPathStyle()
        Returns the name of the style which we will use to render the yahoo path when we are saving a report.
        Returns:
        The name of the style which we will use to render the yahoo path when we are saving a report.

      • setReportYahooPathStyle

        void setReportYahooPathStyle​(java.lang.String value)
        Sets the name of the style used to render the yahoo path when saving a report.
        Parameters:
        value - The name of the style used to render the yahoo path when saving a report.

      • getFilterTemplateYahooPathStyle

        java.lang.String getFilterTemplateYahooPathStyle()
        Returns the name of the style which we will use to render the yahoo path when we are saving a filter or a template.
        Returns:
        The name of the style which we will use to render the yahoo path when we are saving a filter or a template.

      • setFilterTemplateYahooPathStyle

        void setFilterTemplateYahooPathStyle​(java.lang.String value)
        Sets the name of the style used to render the yahoo path when saving a filter or a template.
        Parameters:
        value - The name of the style used to render the yahoo path when saving a filter or a template.

      • getFolderContentStyle

        java.lang.String getFolderContentStyle()
        Returns the name of the style which we will use to render the folder contents.
        Returns:
        The name of the style which we will use to render the the folder contents.

      • setFolderContentStyle

        void setFolderContentStyle​(java.lang.String value)
        Sets the name of the style used to render the the folder contents.
        Parameters:
        value - The name of the style used to render the folder contents.

      • setFolderObjectID

        void setFolderObjectID​(java.lang.String _objectID)
        Since:
        MicroStrategy Web 9.0.0

      • getFolderObjectID

        java.lang.String getFolderObjectID()
        Since:
        MicroStrategy Web 9.0.0

      • setIsFromDesignMode

        void setIsFromDesignMode​(boolean isFromDesignMode)
        Since:
        MicroStrategy Web 9.0.0

      • getIsFromDesignMode

        boolean getIsFromDesignMode()
        Since:
        MicroStrategy Web 9.0.0

      • setSaveAsOriginTarget

        void setSaveAsOriginTarget​(java.lang.String target)
        Since:
        MicroStrategy Web 9.5.0

      • getSaveAsOriginTarget

        java.lang.String getSaveAsOriginTarget()
        Since:
        MicroStrategy Web 9.5.0

      • getIsObjectOverWritten

        boolean getIsObjectOverWritten()
        Since:
        MicroStrategy Web 10.3

      • setIsObjectOverWritten

        void setIsObjectOverWritten​(boolean isOverWritten)
        Since:
        MicroStrategy Web 10.3

      • setResolveOnly

        void setResolveOnly​(boolean resolveOnly)

      • getResolveOnly

        boolean getResolveOnly()