Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

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

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Public Methods

public abstract AppBeanError getBeanError ()

Returns the AppBeanError object associated with the bean.

Returns

the AppBeanError object associated with the bean.

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

the export section of the export bean (a value from EnumExportSection)

public abstract int getExportTextDelimiter ()

Returns

the export text delimiter of the export bean (a value from EnumExportPlaintextDelimiters)

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

Interfaces

Classes

Exceptions

ExportBean

Class Overview

Summary

Public Methods

public abstract AppBeanError getBeanError ()

Returns

public abstract String getCustomReportName ()

Returns

public abstract String getExportData ()

Returns

public abstract boolean getExportFilterDetails ()

Returns

public abstract ExportFormat getExportFormat ()

Returns

public abstract String getExportFormatNameGraphs ()

Returns

public abstract String getExportFormatNameGrids ()

Returns

public abstract boolean getExportHeadersAsText ()

Returns

public abstract boolean getExportMetricValuesAsText ()

Returns

public abstract int getExportSection ()

Returns

public abstract int getExportTextDelimiter ()

Returns

public abstract boolean getFastExport ()

Returns

public abstract int getMaxFileSize ()

Returns

public abstract boolean getOldStyleFilterDetails ()

Returns

public abstract String getOutlineModeState ()

Returns

public abstract boolean getOverlapGridTitles ()

Returns

public abstract boolean getPageByAfterFilterDetails ()

Returns

public abstract boolean getRawDataEnabled ()

Returns

public abstract boolean getRemoveExtraColumn ()

Returns

public abstract ReportBean getReportBean ()

Returns

public abstract String getReportName ()

Returns

public abstract boolean getShowAttributeFormNames ()

Returns

public abstract boolean getUseLiveChartGraphs ()

Returns

public abstract boolean getofficeRefresh ()

Returns

public abstract void setCustomReportName (String customName)

Parameters

public abstract void setExportFilterDetails (boolean filterDetails)

Parameters

public abstract void setExportFormat (ExportFormat exportFormat)

Parameters

public abstract void setExportFormatNameGraphs (String exportFormatNameGraphs)

Parameters

public abstract void setExportFormatNameGrids (String exportFormatNameGrids)

Parameters

public abstract void setExportHeadersAsText (boolean headersAsText)

Parameters

public abstract void setExportMetricValuesAsText (boolean metricValuesAsText)

Parameters

public abstract void setExportSection (int exportSection)

Parameters

public abstract void setExportTextDelimiter (int delimiter)

Parameters

public abstract void setFastExport (boolean value)

Parameters

public abstract void setMaxFileSize (int maxFileSize)

Parameters

public abstract void setOfficeRefresh (boolean officeRefresh)

Parameters

public abstract void setOldStyleFilterDetails (boolean oldStyleFilterDetails)