Package com.infragistics.reveal.sdk.api

Interface IDashboardExporter

public interface IDashboardExporter

The interface that expose methods to allow exporting to different formats.

Method Summary

Modifier and Type	Method	Description
void	export(ExportFormat format, String dashboardId, ExportStreamCallback callback)	Exports a dashboard to a specific format
void	export(ExportFormat format, String dashboardId, IRVUserContext userContext, IExportOptions options, ExportStreamCallback callback)	Exports a dashboard to a specific format
void	export(ExportFormat format, String dashboardId, String filePath, ExportCallback callback)	Exports a dashboard to a specific format
void	export(ExportFormat format, String dashboardId, String filePath, IRVUserContext userContext, IExportOptions options, ExportCallback callback)	Exports a dashboard to a specific format
void	exportToExcel(String dashboardId, ExportStreamCallback callback)	Exports a dashboard to Excel.
void	exportToExcel(String dashboardId, IRVUserContext userContext, ExcelExportOptions options, ExportStreamCallback callback)	Exports a dashboard to Excel.
void	exportToExcel(String dashboardId, String filePath, ExportCallback callback)	Exports a dashboard to Excel.
void	exportToExcel(String dashboardId, String filePath, IRVUserContext userContext, ExcelExportOptions options, ExportCallback callback)	Exports a dashboard to Excel.
void	exportToPdf(String dashboardId, ExportStreamCallback callback)	Exports a dashboard to Pdf.
void	exportToPdf(String dashboardId, IRVUserContext userContext, PdfExportOptions options, ExportStreamCallback callback)	Exports a dashboard to Pdf.
void	exportToPdf(String dashboardId, String filePath, ExportCallback callback)	Exports a dashboard to Pdf.
void	exportToPdf(String dashboardId, String filePath, IRVUserContext userContext, PdfExportOptions options, ExportCallback callback)	Exports a dashboard to Pdf.
void	exportToPowerPoint(String dashboardId, ExportStreamCallback callback)	Exports a dashboard to PowerPoint.
void	exportToPowerPoint(String dashboardId, IRVUserContext userContext, PowerPointExportOptions options, ExportStreamCallback callback)	Exports a dashboard to PowerPoint.
void	exportToPowerPoint(String dashboardId, String filePath, ExportCallback callback)	Exports a dashboard to PowerPoint.
void	exportToPowerPoint(String dashboardId, String filePath, IRVUserContext userContext, PowerPointExportOptions options, ExportCallback callback)	Exports a dashboard to PowerPoint.

Method Detail

export

void export(ExportFormat format,
            String dashboardId,
            ExportStreamCallback callback)
     throws IOException

Exports a dashboard to a specific format

Parameters:

format - ExportFormat indicating the output format.

dashboardId - Dashboard identifier.

callback - Callback method indicating the output stream.

Throws:

IOException

export

void export(ExportFormat format,
            String dashboardId,
            String filePath,
            ExportCallback callback)
     throws IOException

Exports a dashboard to a specific format

Parameters:

format - ExportFormat indicating the output format.

dashboardId - Dashboard identifier.

filePath - Path were the resulting file will be copied.

callback - Callback method indicating the output file path.

Throws:

IOException

export

void export(ExportFormat format,
            String dashboardId,
            IRVUserContext userContext,
            IExportOptions options,
            ExportStreamCallback callback)
     throws IOException

Exports a dashboard to a specific format

Parameters:

format - ExportFormat indicating the output format.

dashboardId - Dashboard identifier.

userContext - The user details credentials, as returned by IRVUserContextProvider implementation.

options - IExportOptions

callback - Callback method indicating the output stream.

Throws:

IOException

export

void export(ExportFormat format,
            String dashboardId,
            String filePath,
            IRVUserContext userContext,
            IExportOptions options,
            ExportCallback callback)
     throws IOException

Exports a dashboard to a specific format

Parameters:

format - ExportFormat indicating the output format.

dashboardId - Dashboard identifier.

filePath - Path were the resulting file will be copied.

userContext - The user details credentials, as returned by IRVUserContextProvider implementation.

options - IExportOptions

callback - Callback method indicating the output file path.

Throws:

IOException

exportToPdf

void exportToPdf(String dashboardId,
                 ExportStreamCallback callback)
          throws IOException

Exports a dashboard to Pdf.

Parameters:

dashboardId - Dashboard identifier.

callback - Callback method indicating the output stream.

Throws:

IOException

exportToPdf

void exportToPdf(String dashboardId,
                 IRVUserContext userContext,
                 PdfExportOptions options,
                 ExportStreamCallback callback)
          throws IOException

Exports a dashboard to Pdf.

Parameters:

dashboardId - Dashboard identifier.

userContext - The user details credentials, as returned by IRVUserContextProvider implementation.

options - Pdf export options PdfExportOptions.

callback - Callback method indicating the output stream.

Throws:

IOException

exportToPdf

void exportToPdf(String dashboardId,
                 String filePath,
                 ExportCallback callback)
          throws IOException

Exports a dashboard to Pdf.

Parameters:

dashboardId - Dashboard identifier.

filePath - Path were the resulting file will be copied.

callback - Callback method indicating the output file path.

Throws:

IOException

exportToPdf

void exportToPdf(String dashboardId,
                 String filePath,
                 IRVUserContext userContext,
                 PdfExportOptions options,
                 ExportCallback callback)
          throws IOException

Exports a dashboard to Pdf.

Parameters:

dashboardId - Dashboard identifier.

filePath - Path were the resulting file will be copied.

userContext - The user details credentials, as returned by IRVUserContextProvider implementation.

options - Pdf export options PdfExportOptions.

callback - Callback method indicating the output file path.

Throws:

IOException

exportToExcel

void exportToExcel(String dashboardId,
                   ExportStreamCallback callback)
            throws IOException

Exports a dashboard to Excel.

Parameters:

dashboardId - Dashboard identifier.

callback - Callback method indicating the output stream.

Throws:

IOException

exportToExcel

void exportToExcel(String dashboardId,
                   IRVUserContext userContext,
                   ExcelExportOptions options,
                   ExportStreamCallback callback)
            throws IOException

Exports a dashboard to Excel.

Parameters:

dashboardId - Dashboard identifier.

userContext - The user details credentials, as returned by IRVUserContextProvider implementation.

options - Excel export options ExcelExportOptions.

callback - Callback method indicating the output stream.

Throws:

IOException

exportToExcel

void exportToExcel(String dashboardId,
                   String filePath,
                   ExportCallback callback)
            throws IOException

Exports a dashboard to Excel.

Parameters:

dashboardId - Dashboard identifier.

filePath - Path were the resulting file will be copied.

callback - Callback method indicating the output file path.

Throws:

IOException

exportToExcel

void exportToExcel(String dashboardId,
                   String filePath,
                   IRVUserContext userContext,
                   ExcelExportOptions options,
                   ExportCallback callback)
            throws IOException

Exports a dashboard to Excel.

Parameters:

dashboardId - Dashboard identifier.

filePath - Path were the resulting file will be copied.

userContext - The user details credentials, as returned by IRVUserContextProvider implementation.

options - Excel export options ExcelExportOptions.

callback - Callback method indicating the output file path.

Throws:

IOException

exportToPowerPoint

void exportToPowerPoint(String dashboardId,
                        ExportStreamCallback callback)
                 throws IOException

Exports a dashboard to PowerPoint.

Parameters:

dashboardId - Dashboard identifier.

callback - Callback method indicating the output stream.

Throws:

IOException

exportToPowerPoint

void exportToPowerPoint(String dashboardId,
                        IRVUserContext userContext,
                        PowerPointExportOptions options,
                        ExportStreamCallback callback)
                 throws IOException

Exports a dashboard to PowerPoint.

Parameters:

dashboardId - Dashboard identifier.

userContext - The user details credentials, as returned by IRVUserContextProvider implementation.

options - PowerPoint export options PowerPointExportOptions.

callback - Callback method indicating the output stream.

Throws:

IOException

exportToPowerPoint

void exportToPowerPoint(String dashboardId,
                        String filePath,
                        ExportCallback callback)
                 throws IOException

Exports a dashboard to PowerPoint.

Parameters:

dashboardId - Dashboard identifier.

filePath - Path were the resulting file will be copied.

callback - Callback method indicating the output file path.

Throws:

IOException

exportToPowerPoint

void exportToPowerPoint(String dashboardId,
                        String filePath,
                        IRVUserContext userContext,
                        PowerPointExportOptions options,
                        ExportCallback callback)
                 throws IOException

Exports a dashboard to PowerPoint.

Parameters:

dashboardId - Dashboard identifier.

filePath - Path were the resulting file will be copied.

userContext - The user details credentials, as returned by IRVUserContextProvider implementation.

options - PowerPoint export options PowerPointExportOptions.

callback - Callback method indicating the output file path.

Throws:

IOException