Package com.microstrategy.web.objects

Interface WebReportExportSettings

All Known Subinterfaces:

WebReportExcelExportSettings, WebReportPDFExportSettings, WebReportPlainTextExportSettings

public interface WebReportExportSettings

Since:

MicroStrategy Web 8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_CUSTOM_EXCEL_REPORT_FOOTER	This custom property setting allows for an arbitrary footer at the beginning of each report for exporting reports to Excel.
static java.lang.String	PROPERTY_CUSTOM_EXCEL_REPORT_HEADER	This custom property setting allows for an arbitrary header at the beginning of each report for exporting reports to Excel.
static java.lang.String	PROPERTY_CUSTOM_REPORT_HEADER	This custom property setting allows for an arbitrary header at the beginning of each report.

Method Summary

Modifier and Type	Method	Description
WebPropertySet	getCustomProperties()	This property set contains properties that govern various custom behavior.
int	getFormatType()	get the format type @link com.microstrategy.webapi.EnumDSSXMLExportFormat} of the export setting
int	getMode()
int	getViewMode()
void	setFormatType(int type)	Set the format type which will be sent as extendable parameter to IServer in rrex command, the type should be EnumDSSXMLExportFormat
void	setMode(int mode)
void	setViewMode(int viewMode)

Field Detail

PROPERTY_CUSTOM_REPORT_HEADER

static final java.lang.String PROPERTY_CUSTOM_REPORT_HEADER

This custom property setting allows for an arbitrary header at the beginning of each report. By default, this is empty.

Since:

MicroStrategy Web 8.1.0

See Also:

Constant Field Values

PROPERTY_CUSTOM_EXCEL_REPORT_HEADER

static final java.lang.String PROPERTY_CUSTOM_EXCEL_REPORT_HEADER

This custom property setting allows for an arbitrary header at the beginning of each report for exporting reports to Excel. By default, this is empty.

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

PROPERTY_CUSTOM_EXCEL_REPORT_FOOTER

static final java.lang.String PROPERTY_CUSTOM_EXCEL_REPORT_FOOTER

This custom property setting allows for an arbitrary footer at the beginning of each report for exporting reports to Excel. By default, this is empty.

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Method Detail

getMode

int getMode()

Returns:

Mode setting from EnumWebReportExportModes

setMode

void setMode(int mode)

Parameters:

mode - Setting from EnumWebReportExportModes

getViewMode

int getViewMode()

setViewMode

void setViewMode(int viewMode)

getCustomProperties

WebPropertySet getCustomProperties()

This property set contains properties that govern various custom behavior. For more information, refer to the property key constants in this interface. This property set cannot be saved (WebPropertySet.save()).

Returns:

property set that governs various custom settings.

Since:

MicroStrategy Web 8.1.0

setFormatType

void setFormatType(int type)

Set the format type which will be sent as extendable parameter to IServer in rrex command, the type should be EnumDSSXMLExportFormat

Parameters:

type -

getFormatType

int getFormatType()

get the format type @link com.microstrategy.webapi.EnumDSSXMLExportFormat} of the export setting

Returns: