public interface

ExportBean

implements AppComponent RequestPersistable
com.microstrategy.web.app.beans.ExportBean

Class Overview

The interface ExportBean is representing the export web component.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract AppBeanError getBeanError()
Returns the AppBeanError object associated with the bean.
abstract String getCustomReportName()
abstract String getExportData()
Returns the export data formatted in accordance with the bean properties.
abstract boolean getExportFilterDetails()
Returns the export filter details property of the export bean.
abstract ExportFormat getExportFormat()
abstract String getExportFormatNameGraphs()
abstract String getExportFormatNameGrids()
abstract boolean getExportHeadersAsText()
Returns the export headers as text property of the export bean.
abstract boolean getExportMetricValuesAsText()
abstract int getExportSection()
abstract int getExportTextDelimiter()
abstract boolean getFastExport()
This method is deprecated. not used anymore
abstract int getMaxFileSize()
Returns the maximum file size to use when exporting.
abstract boolean getOldStyleFilterDetails()
Returns whether to render the filter details section in the old style when exporting to Excel with formatting.
abstract String getOutlineModeState()
Returns the current outline mode expansion state
abstract boolean getOverlapGridTitles()
This method is deprecated. use getRemoveExtraColumn()
abstract boolean getPageByAfterFilterDetails()
Returns whether the page by information is rendered after the filter details section.
abstract boolean getRawDataEnabled()
Returns whether to enable raw data.
abstract boolean getRemoveExtraColumn()
Sets whether to remove the 'Metrics' column when exporting to Excel with formatting.
abstract ReportBean getReportBean()
abstract String getReportName()
abstract boolean getShowAttributeFormNames()
Returns the show attribute forms property of the export bean.
abstract boolean getUseLiveChartGraphs()
Returns whether to use static bitmaps when exporting to Excel with formatting.
abstract boolean getofficeRefresh()
Returns whether to allow MicroStrategy Office to refresh Reports after exporting to Excel.
abstract void setCustomReportName(String customName)
Sets the custom report name to display on the exported results.
abstract void setExportFilterDetails(boolean filterDetails)
Sets the export filter details property of the export bean.
abstract void setExportFormat(ExportFormat exportFormat)
Sets the current export format
abstract void setExportFormatNameGraphs(String exportFormatNameGraphs)
Sets the current export format name for graphs
abstract void setExportFormatNameGrids(String exportFormatNameGrids)
Sets the current export format name for grids
abstract void setExportHeadersAsText(boolean headersAsText)
Sets the export headers as text property of the export bean.
abstract void setExportMetricValuesAsText(boolean metricValuesAsText)
Sets the export metric values as text property of the export bean.
abstract void setExportSection(int exportSection)
Sets the export section of the export bean (a value from EnumExportSection)
abstract void setExportTextDelimiter(int delimiter)
Sets the export text delimiter of the export bean (a value from EnumExportPlaintextDelimiters)
abstract void setFastExport(boolean value)
Sets if the export bean was called by a Fast Export link (new page enforced)
abstract void setMaxFileSize(int maxFileSize)
Sets the maximum file size to use when exporting.
abstract void setOfficeRefresh(boolean officeRefresh)
Sets whether to allow MicroStrategy Office to refresh Reports after exporting to Excel.
abstract void setOldStyleFilterDetails(boolean oldStyleFilterDetails)
Sets whether to render the filter details section in the old style when exporting to Excel with formatting.
abstract void setOutlineModeState(String outlineModeState)
Sets the current outline mode expansion state
abstract void setOverlapGridTitles(boolean overlapGridTitles)
This method is deprecated. use setRemoveExtraColumn(String)
abstract void setPageByAfterFilterDetails(boolean pageByAfterFilterDetails)
Sets whether the page by information is rendered after the filter details section.
abstract void setRawDataEnabled(boolean rawDataEnabled)
Sets whether to enable raw data.
abstract void setRemoveExtraColumn(String overlapGridTitles)
Sets whether to overlap grid titles when exporting to Excel with formatting.
abstract void setReportBean(ReportBean rb)
Sets the report bean associated with this export bean.
abstract void setShowAttributeFormNames(boolean showAttributeFormNames)
Sets the show attribute forms property of the export bean.
abstract void setUseLiveChartGraphs(boolean useLiveChartGraphs)
Sets whether to use static bitmaps when exporting to Excel with formatting.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract AppBeanError getBeanError ()

Returns the AppBeanError object associated with the bean.

Returns

public abstract String getCustomReportName ()

Returns
  • String the custom report name to display on the exported results.

public abstract 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.

public abstract boolean getExportFilterDetails ()

Returns the export filter details property of the export bean.

Returns
  • the export filter details property of the export bean.

public abstract ExportFormat getExportFormat ()

Returns
  • the current ExportFormat

public abstract String getExportFormatNameGraphs ()

Returns
  • the current export format name for graphs

public abstract String getExportFormatNameGrids ()

Returns
  • the current export format name for grids

public abstract boolean getExportHeadersAsText ()

Returns the export headers as text property of the export bean.

Returns
  • the export headers as text property of the export bean.

public abstract boolean getExportMetricValuesAsText ()

Returns
  • the export metric values as text property of the export bean.

public abstract int getExportSection ()

Returns

public abstract int getExportTextDelimiter ()

Returns

public abstract boolean getFastExport ()

This method is 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

public abstract 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.

public abstract 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 ExportFormatExcelWithFormattingIServer

Returns
  • boolean whether to render the filter details section in the old style when exporting to Excel with formatting.

public abstract String getOutlineModeState ()

Returns the current outline mode expansion state

Returns
  • the current outline mode expansion state

public abstract boolean getOverlapGridTitles ()

This method is deprecated.
use getRemoveExtraColumn()

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 ExportFormatExcelWithFormattingIServer

Returns
  • boolean

public abstract boolean getPageByAfterFilterDetails ()

Returns whether the page by information is rendered after the filter details section.
Used when the export format type is ExportFormatExcelWithFormattingIServer

Returns
  • boolean whether the page by information is rendered after the filter details section.

public abstract 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.

public abstract boolean getRemoveExtraColumn ()

Sets whether to remove the 'Metrics' column when exporting to Excel with formatting.
Used when the export format type is ExportFormatExcelWithFormattingIServer

Returns
  • boolean

public abstract ReportBean getReportBean ()

Returns
  • the report bean associated with this export bean

public abstract String getReportName ()

Returns
  • String the report name to display on the exported results. Uses the custom report name if set.

public abstract boolean getShowAttributeFormNames ()

Returns the show attribute forms property of the export bean.

Returns
  • the show attribute forms property of the export bean.

public abstract boolean getUseLiveChartGraphs ()

Returns whether to use static bitmaps when exporting to Excel with formatting.
Used when the export format type is ExportFormatExcelWithFormattingIServer

Returns
  • boolean whether to use static bitmaps when exporting to Excel with formatting.

public abstract boolean getofficeRefresh ()

Returns whether to allow MicroStrategy Office to refresh Reports after exporting to Excel. Used when the export format type is ExportFormatExcelWithFormattingIServer

Returns
  • boolean whether to allow MicroStrategy Office to refresh Reports after exporting to Excel.

public abstract void setCustomReportName (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

public abstract 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.

public abstract void setExportFormat (ExportFormat exportFormat)

Sets the current export format

Parameters
exportFormat the export format

public abstract void setExportFormatNameGraphs (String exportFormatNameGraphs)

Sets the current export format name for graphs

Parameters
exportFormatNameGraphs the export format name for graphs

public abstract void setExportFormatNameGrids (String exportFormatNameGrids)

Sets the current export format name for grids

Parameters
exportFormatNameGrids the export format name for grids

public abstract 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.

public abstract 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.

public abstract 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)

public abstract 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)

public abstract 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

public abstract 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

public abstract void setOfficeRefresh (boolean officeRefresh)

Sets whether to allow MicroStrategy Office to refresh Reports after exporting to Excel.
Used when the export format type is ExportFormatExcelWithFormattingIServer

Parameters
officeRefresh boolean

public abstract 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 ExportFormatExcelWithFormattingIServer

Parameters
oldStyleFilterDetails boolean

public abstract void setOutlineModeState (String outlineModeState)

Sets the current outline mode expansion state

Parameters
outlineModeState the current outline mode expansion state

public abstract void setOverlapGridTitles (boolean overlapGridTitles)

This method is 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 ExportFormatExcelWithFormattingIServer

Parameters
overlapGridTitles boolean whether to overlap grid titles when exporting to Excel with formatting.

public abstract void setPageByAfterFilterDetails (boolean pageByAfterFilterDetails)

Sets whether the page by information is rendered after the filter details section.
Used when the export format type is ExportFormatExcelWithFormattingIServer

Parameters
pageByAfterFilterDetails boolean

public abstract 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

public abstract void setRemoveExtraColumn (String overlapGridTitles)

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 ExportFormatExcelWithFormattingIServer Values: PREFERENCE_YES, PREFERENCE_NO, PREFERENCE_VALUE_FROM_REPORT

Parameters
overlapGridTitles boolean whether to overlap grid titles when exporting to Excel with formatting.

public abstract void setReportBean (ReportBean rb)

Sets the report bean associated with this export bean.

Parameters
rb the report bean to associate with this export bean

public abstract void setShowAttributeFormNames (boolean showAttributeFormNames)

Sets the show attribute forms property of the export bean.

Parameters
showAttributeFormNames indicates whether the export should contain attribute forms.

public abstract void setUseLiveChartGraphs (boolean useLiveChartGraphs)

Sets whether to use static bitmaps when exporting to Excel with formatting.
Used when the export format type is ExportFormatExcelWithFormattingIServer

Parameters
useLiveChartGraphs boolean