Package com.crystaldecisions.sdk.plugin.desktop.common

This package allows you to gather and set processing information on a Crystal report, Desktop Intelligence document, or Web Intelligence document before or after scheduling it.

See:
Description

Interface Summary

CeFormatNames	This interface defines constants that are used in the SI_FORMAT_NAME property of SI_FORMAT_INFO (under Publication.SI_PROCESSINFO.SI_PROCESSINFO_PER_DOC[doc_ID].SI_FORMATINFOS[i]) and the strings in the SI_DESTINATIONS[i].SI_DEST_FORMATS[j].SI_FORMATS collection.
IAuditInfo	Interface for accessing an object's auditing information.
ICacheServerGroupInfo	This interface defines a set of information about the cache server group.
IDestinationProgID
IDestinationProgIDs
IDocumentObject
IDocumentObjects	This interface represents a collection of objects contained in a Web Intelligence or Desktop Intelligence document.
IDynamicRecipientInfo
IDynamicRecipientInfos
IDynamicRecipientProfileValue
IDynamicRecipientProfileValueMasterDoc
IDynamicRecipientProfileValues
IDynamicRecipientProfileValueScopeBatch
IDynamicRecipientProfileValuesSet
IDynamicRecipientVariableMapping
IDynamicRecipientVariableMappings	This interface is a collection used to create and store mappings between columns in a dynamic recipient provider document and variables, formulas, and fields in the document.
IExcelDataOnlyFormat	The IExcelDataOnlyFormat interface allows you to set the options for a report that is to be exported as an Excel spreadsheet.
IExcelFormat	The IExcelFormat interface allows you to set the options for a report that is to be scheduled as an Excel spreadsheet.
IExcelFormat.CeReportExportHeaderFooterOption	Specifies the way page header and footer are exported.
IExcelFormat.SectionType	Specifies the section to base the column width on when exporting to Excel.
IFormatInfo
IFormatInfos
IPageFormat	This abstract interface is used by other exporting sub-classes to set how the pages of a report will be exported.
IPaginatedTextFormat	For internal use only
IPaginatedTextFormat.ExportCharsetType
IPaginatedTextFormat.PageAreaExportType
IPDFFormat	The IPDFFormat interface allows you to set the options for a report that is to be scheduled to a pdf format.
IPersonalizationVariableMapping	This is the common interface for IDynamicRecipientVariableMapping and IPublicationDocumentVariableMapping
IPersonalizationVariableMappings
IPersonalizationVariableValue	This class replaces IScopeProfileValue and IDynamicRecipientProfileValue in Publication Document Processing component
IPersonalizationVariableValue.CeVariableValueType
IProcessingExtension	This interface allows you to retrieve information about a processing extension contained in the ProcessingExtensions Collection.
IProcessingExtensions	This collection allows you to add, delete, and manage customized processing extensions.
IProcessingPublicationInfo	IProcessingPublicationInfo interface defines common publication properties contained in processing bag, It needs to be implemented by publishable documents.
IProcessingServerGroupInfo	This interface defines a set of information about the processing server group.
IPublicationDocumentVariableMapping
IPublicationDocumentVariableMappings
IPublicationDynamicRecipients	This interface defines a collection that contains IPublicationDynamicRecipient objects.
IPublicationInfo	This interface defines common publication properties that need to be implemented by publishable documents.
IReportAlert	This interface allows you to specify the alert information that is displayed in an alert notification email.
IReportAlerts	This collection contains the list of alerts defined in a given report.
IReportFormatOptions	This interface allows you to set the export format type for a report and retrieve specific export objects to set more detailed format options.
IReportFormatOptions.CeReportFormat	Specifies the Report Format Type for scheduling the export of a report.
IReportHyperlink	This interface provides the support necessary to use the report hyperlink object within reports.
IReportHyperlink.CeHyperlinkType	Specifies the hyperlink type, used when retrieving a hyperlink for export.
IReportLogon	The IReportLogon interface contains logon information for a database the report must retrieve data from.
IReportLogon.CeReportLogonMode	Specifies the report logon mode
IReportLogon.CeReportServerType	Specifies the Report Database Server Type.
IReportParameter	The IReportParameter interface represents a single parameter for a particular report.
IReportParameter.ParameterPickListSortMethod	Deprecated.
IReportParameter.ReportVariableValueType	The type of the parameter value.
IReportParameterRangeValue	The IReportParameterRangeValue interface stores detailed information about the parameter value if it is a range value.
IReportParameterSingleValue	The IReportParameterSingleValue interface stores detailed information about the parameter value itself, if it is a single value.
IReportParameterValue	The IReportParameterValue interface enables you to examine any one of the default or current values of a parameter.
IReportParameterValue.DateFormat	This interface is used to specify the date parse format.
IReportParameterValues	The IReportParameterValues interface returns a collection of IReportParameterValue objects that represent the value, or values, for a specified parameter.
IReportPrinterOptions	This interface allows you to set the printer options for a report.
IReportPrinterOptions.CePageSize	Specified Report Page Size.
IReportPrinterOptions.CePrintCollateType	Specifies the report print collation.
IReportPrinterOptions.CePrintScaleOption
IReportPrinterOptions.CeReportLayout	Specifies Report Layout.
IReportProcessingExtension	This interface allows you to retrieve information about a processing extension contained in the IReportProcessingExtensions collection.
IReportProcessingExtensions	This collection allows you to add, delete, and manage customized processing extensions that are applied to the report.
IReportProcessingInfo	This interface is used to gather and set processing information on a report or a report instance, before or after running the report.
IReportProcessingInfo.CeProcType	For internal use only.
IReportProcessingInfo.CEReportEngineType	For internal use only.
IReportRefreshOptions	This interface is used for setting the report refresh options used when refreshing report properties.
IReportRefreshOptions.CeRefreshOption	Specifies the report refresh options.
IReportTablePrefix	The IReportTablePrefix interface allows you to change the table prefix template.
IReportXMLExportItem	This interface provides the support necessary to get the report XSLT export item information within reports.
IRichTextFormat	The IRichTextFormat interface allows you to set the options for a report that is to be scheduled to a rich text format.
IRichTextFormatEditable	This interface allows you to set custom options for a report that is to be scheduled to a rich text format.
IScopeBatchScope	This interface provides detailed information about a scope within a scope batch.
IScopeBatchScopes	IScopeBatchScopes is a collection of IScopeBatchScope.
IScopePrincipals	IScopePrincipals is a interface represent a collection of principals for the given scope.
IScopeProfileValue
IScopeProfileValues
ITextFormatCharacterSeparated	This interface allows you to set the options when exporting a report to a text file with character separated values.
ITextFormatPaginated	This interface allows you to set the options when exporting a report to a paginated text file.
ITextFormatPlain	This interface allows you to set the options when exporting a report to a plain text file.
ITextFormatSeparated
ITextFormatSeparated.CeExportMode
ITextFormatSeparated.CeGroupSectionsOption
ITextFormatSeparated.CeReportSectionsOption
ITextFormatTabSeparated	This interface allows you to set the options when exporting a report to a text file with tab separated values.
ITextFormatTabSeparatedText	The ITextFormatTabSeparatedText interface allows you to set the options for a report that is to be scheduled to a text format with a set of data records, layout is not exported.
IViewingServerGroupInfo
IWordFormat	The IWordFormat interface allows you to set the options for a report that is to be scheduled to a word format.
IXMLFormat	The IXMLFormat interface allows you to set the selected XML export item's index for a report that is to be scheduled to an XML (or XSLT) format.

Class Summary

IReportProcessingInfo.DataSourceLanguageLevel

For internal use only.

Package com.crystaldecisions.sdk.plugin.desktop.common Description

This package allows you to gather and set processing information on a Crystal report, Desktop Intelligence document, or Web Intelligence document before or after scheduling it. It allows export format options, processing extensions, logon information, as well as report parameters to be retrieved or set. To access more basic report information from a report plugin object, use the IReport interface.

Retrieving desktop plugins

Each object that is created with a desktop plugin is stored in either the CI_INFOOBJECTS or the CI_SYSTEMOBJECTS category in the CMS InfoStore, and is marked with a programmatic identifier (SI_KIND). Using SI_KIND, you can query the CMS InfoStore for a collection of objects.

Example

The following query selects the names and IDs of all Report objects in the CMS:

IInfoObjects objs = iStore.query("SELECT SI_NAME, SI_ID FROM CI_INFOOBJECTS WHERE SI_KIND='CrystalReport'");

The query method returns a collection of InfoObjects, which in this case are report plugin objects. Like other InfoObjects, these objects are uniquely represented by their ID property. For each object in the collection, you can access general InfoObject properties, such as the SI_NAME property, SI_DESCRIPTION property, and SI_ID property.

To access the IReportProcessingInfo object returned by the query, the resulting IInfoObjects need to be cast. This example demonstrates how to cast the returned IInfoObjects as IReportProcessingInfo objects.

for ( int i = 0; i < objs.size(); i++ )
{
    IInfoObject obj = (IInfoObject) objs.get( i );
    IReportProcessingInfo processingInfo = (IReportProcessingInfo) obj;
}

Note: The IReportProcessingInfo object can be cast as an IReport object to set more basic methods if the object is a report plugin. However, all report format objects, such as IExcel, IPDF, IRTF, ITxt, and IWord can be cast as IReportProcessingInfo objects, but not IReport objects.

See Also:

IReport