Package com.microstrategy.web.app.beans

Interface ExportBean

    • Method Detail

      • getReportBean

        ReportBean getReportBean()
        Returns:
        the report bean associated with this export bean

      • setReportBean

        void setReportBean​(ReportBean rb)
        Sets the report bean associated with this export bean.
        Parameters:
        rb - the report bean to associate with this export bean

      • getExportFormat

        ExportFormat getExportFormat()
        Returns:
        the current ExportFormat

      • setExportFormat

        void setExportFormat​(ExportFormat exportFormat)
        Sets the current export format
        Parameters:
        exportFormat - the export format

      • getExportFormatNameGrids

        java.lang.String getExportFormatNameGrids()
        Returns:
        the current export format name for grids

      • setExportFormatNameGrids

        void setExportFormatNameGrids​(java.lang.String exportFormatNameGrids)
        Sets the current export format name for grids
        Parameters:
        exportFormatNameGrids - the export format name for grids

      • getExportFormatNameGraphs

        java.lang.String getExportFormatNameGraphs()
        Returns:
        the current export format name for graphs

      • setExportFormatNameGraphs

        void setExportFormatNameGraphs​(java.lang.String exportFormatNameGraphs)
        Sets the current export format name for graphs
        Parameters:
        exportFormatNameGraphs - the export format name for graphs

      • getExportSection

        int getExportSection()
        Returns:
        the export section of the export bean (a value from EnumExportSection)

      • setExportSection

        void setExportSection​(int exportSection)
        Sets the export section of the export bean (a value from EnumExportSection)
        Parameters:
        exportSection - the export section of the export bean (a value from EnumExportSection)

      • getExportTextDelimiter

        int getExportTextDelimiter()
        Returns:
        the export text delimiter of the export bean (a value from EnumExportPlaintextDelimiters)
        Since:
        MicroStrategy Web 7.5.0

      • setExportTextDelimiter

        void setExportTextDelimiter​(int delimiter)
        Sets the export text delimiter of the export bean (a value from EnumExportPlaintextDelimiters)
        Parameters:
        delimiter - the export text delimiter of the export bean (a value from EnumExportPlaintextDelimiters)
        Since:
        MicroStrategy Web 7.5.0

      • getExportMetricValuesAsText

        boolean getExportMetricValuesAsText()
        Returns:
        the export metric values as text property of the export bean.

      • setExportMetricValuesAsText

        void setExportMetricValuesAsText​(boolean metricValuesAsText)
        Sets the export metric values as text property of the export bean.
        Parameters:
        metricValuesAsText - indicates whether the export should take the metric values as text.

      • getExportHeadersAsText

        boolean getExportHeadersAsText()
        Returns the export headers as text property of the export bean.
        Returns:
        the export headers as text property of the export bean.

      • setExportHeadersAsText

        void setExportHeadersAsText​(boolean headersAsText)
        Sets the export headers as text property of the export bean.
        Parameters:
        headersAsText - indicates whether the export should take the headers as text.

      • getExportFilterDetails

        boolean getExportFilterDetails()
        Returns the export filter details property of the export bean.
        Returns:
        the export filter details property of the export bean.

      • setExportFilterDetails

        void setExportFilterDetails​(boolean filterDetails)
        Sets the export filter details property of the export bean.
        Parameters:
        filterDetails - indicates whether the export should contain the filter details.

      • getShowAttributeFormNames

        boolean getShowAttributeFormNames()
        Returns the show attribute forms property of the export bean.
        Returns:
        the show attribute forms property of the export bean.

      • setShowAttributeFormNames

        void setShowAttributeFormNames​(boolean showAttributeFormNames)
        Sets the show attribute forms property of the export bean.
        Parameters:
        showAttributeFormNames - indicates whether the export should contain attribute forms.

      • getExportData

        java.lang.String getExportData()
        Returns the export data formatted in accordance with the bean properties. Used while exporting grids to plain text (e.g. CSV, plain text and excel with text).
        Returns:
        the export data formatted in accordance with the bean properties.

      • getFastExport

        boolean getFastExport()
        Deprecated.
        not used anymore
        Returns if the export bean was called by a Fast Export link (new page enforced)
        Returns:
        a boolean value indicating if the request comes from a Fast Export link

      • setFastExport

        void setFastExport​(boolean value)
        Sets if the export bean was called by a Fast Export link (new page enforced)
        Parameters:
        value - a boolean value indicating if the request comes from a Fast Export link

      • getOutlineModeState

        java.lang.String getOutlineModeState()
        Returns the current outline mode expansion state
        Returns:
        the current outline mode expansion state
        Since:
        MicroStrategy Web 8.0.0

      • setOutlineModeState

        void setOutlineModeState​(java.lang.String outlineModeState)
        Sets the current outline mode expansion state
        Parameters:
        outlineModeState - the current outline mode expansion state
        Since:
        MicroStrategy Web 8.0.0

      • getRawDataEnabled

        boolean getRawDataEnabled()
        Returns whether to enable raw data.
        This is necessary for the number formatting.
        Having enabled affects performance.
        Returns:
        Returns whether to enable raw data.
        Since:
        MicroStrategy Web 7.5.4

      • setRawDataEnabled

        void setRawDataEnabled​(boolean rawDataEnabled)
        Sets whether to enable raw data.
        This is necessary for the number formatting.
        Having enabled affects performance.
        Parameters:
        rawDataEnabled - whether to enable raw data
        Since:
        MicroStrategy Web 7.5.4

      • getMaxFileSize

        int getMaxFileSize()
        Returns the maximum file size to use when exporting.
        The file name is normally the report name and it will get truncated to this value if needed.
        This is used for a limit of characters imposed by Internet Explorer documented on : http://support.microsoft.com/kb/213983
        Returns:
        int the maximum file size to use when exporting.
        Since:
        MicroStrategy Web 7.5.4

      • setMaxFileSize

        void setMaxFileSize​(int maxFileSize)
        Sets the maximum file size to use when exporting.
        The file name is normally the report name and it will get truncated to this value if needed.
        This is used for a limit of characters imposed by Internet Explorer documented on : http://support.microsoft.com/kb/213983
        Parameters:
        maxFileSize - the maximum file size to use when exporting
        Since:
        MicroStrategy Web 7.5.4

      • setUseLiveChartGraphs

        void setUseLiveChartGraphs​(boolean useLiveChartGraphs)
        Sets whether to use static bitmaps when exporting to Excel with formatting.
        Used when the export format type is EnumExportFormats.ExportFormatExcelWithFormattingIServer
        Parameters:
        useLiveChartGraphs - boolean
        Since:
        MicroStrategy Web 8.0.1

      • getUseLiveChartGraphs

        boolean getUseLiveChartGraphs()
        Returns whether to use static bitmaps when exporting to Excel with formatting.
        Used when the export format type is EnumExportFormats.ExportFormatExcelWithFormattingIServer
        Returns:
        boolean whether to use static bitmaps when exporting to Excel with formatting.
        Since:
        MicroStrategy Web 8.0.1

      • setOverlapGridTitles

        void setOverlapGridTitles​(boolean overlapGridTitles)
        Deprecated.
        use setRemoveExtraColumn(String)
        Sets whether to overlap grid titles when exporting to Excel with formatting.
        Removes the "Metrics" column on the grid.
        Used when the export format type is EnumExportFormats.ExportFormatExcelWithFormattingIServer
        Parameters:
        overlapGridTitles - boolean whether to overlap grid titles when exporting to Excel with formatting.
        Since:
        MicroStrategy Web 8.0.1

      • getRemoveExtraColumn

        boolean getRemoveExtraColumn()
        Sets whether to remove the 'Metrics' column when exporting to Excel with formatting.
        Used when the export format type is EnumExportFormats.ExportFormatExcelWithFormattingIServer
        Returns:
        boolean
        Since:
        MicroStrategy Web 9.0.0

      • setOldStyleFilterDetails

        void setOldStyleFilterDetails​(boolean oldStyleFilterDetails)
        Sets whether to render the filter details section in the old style when exporting to Excel with formatting.
        Used when the export format type is EnumExportFormats.ExportFormatExcelWithFormattingIServer
        Parameters:
        oldStyleFilterDetails - boolean
        Since:
        MicroStrategy Web 8.0.1

      • getOldStyleFilterDetails

        boolean getOldStyleFilterDetails()
        Returns whether to render the filter details section in the old style when exporting to Excel with formatting.
        Used when the export format type is EnumExportFormats.ExportFormatExcelWithFormattingIServer
        Returns:
        boolean whether to render the filter details section in the old style when exporting to Excel with formatting.
        Since:
        MicroStrategy Web 8.0.1

      • setPageByAfterFilterDetails

        void setPageByAfterFilterDetails​(boolean pageByAfterFilterDetails)
        Sets whether the page by information is rendered after the filter details section.
        Used when the export format type is EnumExportFormats.ExportFormatExcelWithFormattingIServer
        Parameters:
        pageByAfterFilterDetails - boolean
        Since:
        MicroStrategy Web 8.0.1

      • getPageByAfterFilterDetails

        boolean getPageByAfterFilterDetails()
        Returns whether the page by information is rendered after the filter details section.
        Used when the export format type is EnumExportFormats.ExportFormatExcelWithFormattingIServer
        Returns:
        boolean whether the page by information is rendered after the filter details section.
        Since:
        MicroStrategy Web 8.0.1

      • setOfficeRefresh

        void setOfficeRefresh​(boolean officeRefresh)
        Sets whether to allow MicroStrategy Office to refresh Reports after exporting to Excel.
        Used when the export format type is EnumExportFormats.ExportFormatExcelWithFormattingIServer
        Parameters:
        officeRefresh - boolean
        Since:
        MicroStrategy Web 8.0.1

      • getofficeRefresh

        boolean getofficeRefresh()
        Returns whether to allow MicroStrategy Office to refresh Reports after exporting to Excel. Used when the export format type is EnumExportFormats.ExportFormatExcelWithFormattingIServer
        Returns:
        boolean whether to allow MicroStrategy Office to refresh Reports after exporting to Excel.
        Since:
        MicroStrategy Web 8.0.1

      • setCustomReportName

        void setCustomReportName​(java.lang.String customName)
        Sets the custom report name to display on the exported results. If set it will overwrite the real report name.
        Parameters:
        customName - String the custom report name to display on the exported results
        Since:
        MicroStrategy Web 8.0.2

      • getCustomReportName

        java.lang.String getCustomReportName()
        Returns:
        String the custom report name to display on the exported results.
        Since:
        MicroStrategy Web 8.0.2

      • getReportName

        java.lang.String getReportName()
        Returns:
        String the report name to display on the exported results. Uses the custom report name if set.
        Since:
        MicroStrategy Web 8.0.2