com.crystaldecisions.sdk.plugin.desktop.report
Interface IReportBase

All Superinterfaces:

ICacheServerGroupInfo, IProcessingPublicationInfo, IProcessingServerGroupInfo, IReportProcessingInfo, IViewingServerGroupInfo

All Known Subinterfaces:

IReport

public interface IReportBase
extends IReportProcessingInfo

This interface enables getting and setting basic information about the report.

Nested Class Summary

static interface

IReportBase.CEReportAddProcType For internal use only

Nested classes/interfaces inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IReportProcessingInfo

IReportProcessingInfo.CeProcType, IReportProcessingInfo.CEReportEngineType, IReportProcessingInfo.DataSourceLanguageLevel

Field Summary

static java.lang.String	KIND
static java.lang.String	PROGID The ProgID for the Report Class.

Method Summary

java.util.Set	getBusinessViews() Gets a collection of Business View IDs that have been assigned to this report.
IReportHyperlinkResolves	getHyperlinkResolves() Gets a IReportHyperlinkResolves collection.
java.lang.String	getMimeType() For internal use only Gets MIME type
java.lang.String	getReportFileName() Gets the ReportFileName.
IReportRefreshOptions	getReportRefreshOptions() Get the report refresh options.
boolean	getRetainDCPsOnSave() For internal use only
TranslationTable	getTranslations() For internal use only get the translation table from the report infostore object
boolean	isKeepSavedData() Gets a boolean that indicates whether saved data will be kept in this object when the report is added.
boolean	isRepositoryEnabled() Gets a boolean that indicates whether this object needs access to a repository data source.
boolean	isThumbnailEnabled() Gets the value for SI_TURNONTHUMBNAIL.
boolean	isUseOldPromptStyle() Gets a boolean that indicates whether the report uses the old prompt style.
void	refreshProperties() Refreshes the properties from the report according to the options.
void	setKeepSavedData(boolean keep) Sets a boolean that indicates whether saved date will be kept in this object when the report is added.
void	setRepositoryEnabled(boolean enabled) Sets a boolean that indicates whether this object needs access to a repository data source.
void	setThumbnailEnabled(boolean bEnable) Sets the value for SI_TURNONTHUMBNAIL.
void	setTranslations(TranslationTable table) For internal use only set the translation table into the report infostore object
void	setUseOldPromptStyle(boolean useOldStyle) Sets a boolean that indicates whether the report uses the old prompt style.

Methods inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IReportProcessingInfo

getDataSourceLanguageLevel, getFallbackLocale, getGroupFormula, getProcessedLocales, getProcessingSecurityExtensions, getPromptGroupMembers, getRecordFormula, getReportAddProcType, getReportAlerts, getReportDefaultXMLExportSelection, getReportEngineType, getReportFormatOptions, getReportHyperlinks, getReportLogons, getReportParameters, getReportPrinterOptions, getReportSavedXMLExportSelection, getReportXMLInfo, getRunLocales, getScheduledPVL, getSchedulingNumPagesToGenerate, getTotalPageCount, getViewingLOVShareInterval, getViewingShareInterval, getVisibleLocales, hasDisplayCustomDBConfiguration, hasDisplayOriginalDBConfiguration, hasDynamicCascadePrompt, isLogonNeeded, isRPTR, isSchedulingEnableTotalPageCount, isSchedulingUseReportGenerateCacheSettings, isSchedulingUseReportPageCountSettings, isViewingShareHitDBOnRefresh, isViewingShareReport, isViewingUseLOVCustomSharingSettings, isViewingUseReportSharingSettings, queryRepositoryOptions, setGroupFormula, setLogonNeeded, setProcessedLocales, setRecordFormula, setReportAddProcType, setRunLocales, setSchedulingEnableTotalPageCount, setSchedulingNumPagesToGenerate, setSchedulingUseReportGenerateCacheSettings, setSchedulingUseReportPageCountSettings, setViewingLOVShareInterval, setViewingShareHitDBOnRefresh, setViewingShareInterval, setViewingShareReport, setViewingUseLOVCustomSharingSettings, setViewingUseReportSharingSettings

Methods inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IViewingServerGroupInfo

getViewingServerGroup, getViewingServerGroupChoice, setViewingServerGroup, setViewingServerGroupChoice

Methods inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IProcessingServerGroupInfo

getProcessingServerGroup, getProcessingServerGroupChoice, setProcessingServerGroup, setProcessingServerGroupChoice

Methods inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.ICacheServerGroupInfo

getCacheServerGroup, getCacheServerGroupChoice, setCacheServerGroup, setCacheServerGroupChoice

Methods inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IProcessingPublicationInfo

getDeliveryRuleExpression, getDeliveryRuleResults, getDeliverySkipped, getFormatInfos, getIsDynamicRecipientsScopeBatch, getPublicationKeepSavedData, getPublicationLastState, getScopeBatchScopes, getSourceDocumentID, isDeliverEmptyDocument, isDeliverIfAlertIsTrue, removeDeliveryRuleResults, setDeliverEmptyDocument, setDeliverIfAlertIsTrue, setDeliveryRuleExpression, setDeliveryRuleResults, setDeliverySkipped, setIsDynamicRecipientsScopeBatch, setPublicationKeepSavedData, setPublicationLastState, setSourceDocumentID

Field Detail

KIND

static final java.lang.String KIND

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the Report Class.

ProgID	CrystalEnterprise.Report
Query Category	CI_INFOOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.desktop.report.IReport

Query syntax:

SELECT
	SI_FILES, SI_TURNONTHUMBNAIL
FROM
	CI_INFOOBJECTS
WHERE
	SI_PROGID='CrystalEnterprise.Report'

The CePropertyIDs named in the SELECT statement are those that are required to access data through the IReport interface. For more information on their associations with the interface's methods, see IReport

See Also:

Constant Field Values

Method Detail

getReportFileName

java.lang.String getReportFileName()
                                   throws SDKException

Gets the ReportFileName.

Returns:

A String containing the report file name value.

Throws:

SDKException

isThumbnailEnabled

boolean isThumbnailEnabled()
                           throws SDKException

Gets the value for SI_TURNONTHUMBNAIL. A thumbnail will only be displayed if it was generated when the report was created.

Returns:

true if thumbnail is enabled for this object.

Throws:

SDKException

setThumbnailEnabled

void setThumbnailEnabled(boolean bEnable)

Sets the value for SI_TURNONTHUMBNAIL. A thumbnail will only be displayed if it was generated when the report was created.

Parameters:

bEnable - true to enable the thumbnail for this object, false otherwise.

isRepositoryEnabled

boolean isRepositoryEnabled()

Gets a boolean that indicates whether this object needs access to a repository data source.

Specified by:

isRepositoryEnabled in interface IReportProcessingInfo

Returns:

true if this object needs access to a repository data source, and false otherwise.

setRepositoryEnabled

void setRepositoryEnabled(boolean enabled)

Sets a boolean that indicates whether this object needs access to a repository data source.

Specified by:

setRepositoryEnabled in interface IReportProcessingInfo

Parameters:

enabled - true if this object needs access to a repository data source.

refreshProperties

void refreshProperties()
                       throws SDKException

Refreshes the properties from the report according to the options.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getReportRefreshOptions

IReportRefreshOptions getReportRefreshOptions()
                                              throws SDKException

Get the report refresh options. The options will be used when refreshing the properties from the report.

Returns:

Refresh options for this report plugin

Throws:

SDKException - This is thrown if the process is unsuccessful.

getHyperlinkResolves

IReportHyperlinkResolves getHyperlinkResolves()
                                              throws SDKException

Gets a IReportHyperlinkResolves collection.

Returns:

A IReportHyperlinkResolves collection.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isKeepSavedData

boolean isKeepSavedData()
                        throws SDKException

Gets a boolean that indicates whether saved data will be kept in this object when the report is added.

Returns:

true if this object will keep the saved data in the report file, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setKeepSavedData

void setKeepSavedData(boolean keep)
                      throws SDKException

Sets a boolean that indicates whether saved date will be kept in this object when the report is added.

Parameters:

keep - true if this object preserves the saved data in the report file.

Throws:

SDKException

getBusinessViews

java.util.Set getBusinessViews()
                               throws SDKException

Gets a collection of Business View IDs that have been assigned to this report.

Returns:

A Set that contains Business View IDs that have been assigned to this report.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setUseOldPromptStyle

void setUseOldPromptStyle(boolean useOldStyle)
                          throws SDKException

Sets a boolean that indicates whether the report uses the old prompt style.

Parameters:

useOldStyle - A boolean that indicates whether the report uses the old prompt style.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isUseOldPromptStyle

boolean isUseOldPromptStyle()
                            throws SDKException

Gets a boolean that indicates whether the report uses the old prompt style.

Returns:

true if the report uses the old prompt style, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMimeType

java.lang.String getMimeType()

For internal use only

Gets MIME type

Returns:

a String that tells MIME type

setTranslations

void setTranslations(TranslationTable table)
                     throws SDKException

For internal use only

set the translation table into the report infostore object

Throws:

SDKException

getTranslations

TranslationTable getTranslations()
                                 throws SDKException

For internal use only

get the translation table from the report infostore object

Throws:

SDKException

getRetainDCPsOnSave

boolean getRetainDCPsOnSave()

For internal use only