com.crystaldecisions.sdk.plugin.desktop.common
Interface IFormatInfo

public interface IFormatInfo

Method Summary

java.lang.Object	getCRFormatInterface() Deprecated. use IFormatInfo.getFormatOptionsObject(java.lang.String) instead
int	getFormat() Deprecated. As of version 12.0. Use IFormatInfo.getFormat(String) instead.
int	getFormat(java.lang.String kind) Returns the format of the publication artifact.
java.lang.Object	getFormatOptionsObject(java.lang.String kind) Returns the format options of the document.
java.lang.String	getFormatString() Gets the format of the publication artifact.
IDocumentObjects	getSelectedDocumentObjects() Returns the collection of objects in the document that have been chosen for this format.
java.lang.String	getSourceDocumentKind() Deprecated. It is no longer required to set source document kind
boolean	isUseExportOptionsInReport() Deprecated. use getFormatOptionsObject instead
void	setFormat(java.lang.String kind, int format) Sets the format of the publication artifact.
void	setFormatString(java.lang.String format) Sets the format of the publication artifact.
void	setSourceDocumentKind(java.lang.String srcDocKind) Deprecated. It is no longer necessary to set source document kind
void	setUseExportOptionsInReport(boolean value) Deprecated. use getFormatOptionsObject instead

Method Detail

getFormatString

java.lang.String getFormatString()

Gets the format of the publication artifact. This is the recommended method to get the format for document types other than CeKind.CRYSTAL_REPORT, CeKind.WEBI, and CeKind.FullClient. For CeKind.CRYSTAL_REPORT, CeKind.WEBI, and CeKind.FullClient, use IFormatInfo.getFormat(String) instead.

Returns:

setFormatString

void setFormatString(java.lang.String format)

Sets the format of the publication artifact. This is the recommended method to specify the format for document types other than CeKind.CRYSTAL_REPORT, CeKind.WEBI, and CeKind.FullClient. For CeKind.CRYSTAL_REPORT, CeKind.WEBI, and CeKind.FullClient, use IFormatInfo.setFormat(String, int) instead.

Parameters:

format - String representation of the format of the publication artifact.

getFormat

int getFormat(java.lang.String kind)
              throws SDKException

Returns the format of the publication artifact. This is the recommended method to get the format only for the document types CeKind.CRYSTAL_REPORT, CeKind.WEBI, and CeKind.FullClient. For other document types use IFormatInfo.getFormatString() instead.

Parameters:

kind - The kind of the source document of this publication artifact.

Returns:

A numeric representation of the format of the publication artifact.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setFormat

void setFormat(java.lang.String kind,
               int format)
               throws SDKException

Sets the format of the publication artifact. This is the recommended method to specify the format only for the document types CeKind.CRYSTAL_REPORT, CeKind.WEBI, and CeKind.FullClient. For other document types use IFormatInfo.setFormatString(String) instead.

Parameters:

kind - The kind of the source document for this publication artifact.

format - The numeric format of the publication artifact

Throws:

SDKException - This is thrown if the process is unsuccessful.

getSourceDocumentKind

java.lang.String getSourceDocumentKind()

Deprecated. It is no longer required to set source document kind

Returns the kind of the source document for this publication artifact.

Returns:

The kind of the source document for this publication artifact.

See Also:

CeKind

setSourceDocumentKind

void setSourceDocumentKind(java.lang.String srcDocKind)
                           throws SDKException

Deprecated. It is no longer necessary to set source document kind

Sets the kind of the source document for this publication artifact.

Parameters:

srcDocKind - the kind of the sourc docuemnt for this publication artifact.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

CeKind

getFormat

int getFormat()
              throws SDKException

Deprecated. As of version 12.0. Use IFormatInfo.getFormat(String) instead.

Returns the format of the publication artifact.

Returns:

The format of the publication artifact.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCRFormatInterface

java.lang.Object getCRFormatInterface()
                                      throws SDKException

Deprecated. use IFormatInfo.getFormatOptionsObject(java.lang.String) instead

Returns the format options for the document. This is applicable to Crystal Reports documents only.

Returns:

An Object containing Crystal Reports format options.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isUseExportOptionsInReport

boolean isUseExportOptionsInReport()
                                   throws SDKException

Deprecated. use getFormatOptionsObject instead

Returns whether the report uses export options. This is applicable to Crystal Reports documents only.

Returns:

true if the report uses export options, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setUseExportOptionsInReport

void setUseExportOptionsInReport(boolean value)
                                 throws SDKException

Deprecated. use getFormatOptionsObject instead

Sets whether the report uses export options. This is applicable to Crystal Reports documents only.

Parameters:

value - true if the report uses export options, false otherwise

Throws:

SDKException - This is thrown if the process is unsuccessful.

getSelectedDocumentObjects

IDocumentObjects getSelectedDocumentObjects()
                                            throws SDKException

Returns the collection of objects in the document that have been chosen for this format. This is applicable to Web Intelligence and Desktop Intelligence documents only.

Returns:

IDocumentObjects of objects within a report.

Throws:

SDKException - If the list cannot be retrieved.

getFormatOptionsObject

java.lang.Object getFormatOptionsObject(java.lang.String kind)
                                        throws SDKException

Returns the format options of the document.

Parameters:

kind - a document type, such as CeKind.CRYSTAL_REPORTS, CeKind.WEBI, or CeKind.FullClient.

Returns:

the document-specific format options interface

Throws:

SDKException - This is thrown if the process is unsuccessful.