public interface

WebReportExportSettings

com.microstrategy.web.objects.WebReportExportSettings
Known Indirect Subclasses

Summary

Constants
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.
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.
String PROPERTY_CUSTOM_REPORT_HEADER This custom property setting allows for an arbitrary header at the beginning of each report.
Public Methods
abstract WebPropertySet getCustomProperties()
This property set contains properties that govern various custom behavior.
abstract int getFormatType()
get the format type @link com.microstrategy.webapi.EnumDSSXMLExportFormat} of the export setting
abstract int getMode()
abstract int getViewMode()
abstract 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
abstract void setMode(int mode)
abstract void setViewMode(int viewMode)

Constants

public static final 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.

Constant Value: "ExcelReportFooter"

public static final 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.

Constant Value: "ExcelReportHeader"

public static final 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.

Constant Value: "ReportHeader"

Public Methods

public abstract 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 (save()).

Returns
  • property set that governs various custom settings.

public abstract int getFormatType ()

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

public abstract int getMode ()

Returns

public abstract int getViewMode ()

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

public abstract void setMode (int mode)

Parameters
mode Setting from EnumWebReportExportModes

public abstract void setViewMode (int viewMode)