com.businessobjects.sdk.plugin.desktop.webi
Interface IWebiFormatOptions

public interface IWebiFormatOptions

This interface allows you to set the export format type for a Web Intelligence document.

Nested Class Summary

static interface

IWebiFormatOptions.CeWebiFormat The export format types for a Web Intelligence document.

Method Summary

int	getFormat() Returns the export format type for this Web Intelligence document.
java.util.Map	getFormatOptions(int formatType) Gets the format options for this Web Intelligence document.
void	setFormat(int formatType) Sets the export format type for this Web Intelligence document.
void	setFormatOptions(int formatType, java.lang.String txtQlf, java.lang.String colDelm, java.lang.String chSet, boolean isSepCsv) Sets the format options for this Web Intelligence document .

Method Detail

getFormat

int getFormat()

Returns the export format type for this Web Intelligence document.

Returns:

An int that specifies the export format type for this document. This is of type CeWebiFormat.

See Also:

IWebiFormatOptions.CeWebiFormat

setFormat

void setFormat(int formatType)
               throws SDKException

Sets the export format type for this Web Intelligence document.

Parameters:

formatType - An int of type CeWebiFormat which specifies the export format type for this report.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setFormatOptions

void setFormatOptions(int formatType,
                      java.lang.String txtQlf,
                      java.lang.String colDelm,
                      java.lang.String chSet,
                      boolean isSepCsv)
                      throws SDKException

Sets the format options for this Web Intelligence document .

Parameters:

formatType - An int of type CeWebiFormat which specifies the export format type for this report.

txtQlf -

colDelm -

chSet -

isSepCsv -

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFormatOptions

java.util.Map getFormatOptions(int formatType)
                               throws SDKException

Gets the format options for this Web Intelligence document.

Parameters:

formatType - An int of type CeWebiFormat which specifies the export format type for this report.

Throws:

SDKException - This is thrown if the process is unsuccessful.