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

All Superinterfaces:

ICacheServerGroupInfo, IProcessingPublicationInfo, IProcessingServerGroupInfo, IViewingServerGroupInfo

All Known Subinterfaces:

IReport, IReportBase

public interface IReportProcessingInfo
extends IViewingServerGroupInfo, IProcessingServerGroupInfo, ICacheServerGroupInfo, IProcessingPublicationInfo

This interface is used to gather and set processing information on a report or a report instance, before or after running the report.

Nested Class Summary

static interface	IReportProcessingInfo.CeProcType For internal use only.
static interface	IReportProcessingInfo.CEReportEngineType For internal use only.
static class	IReportProcessingInfo.DataSourceLanguageLevel For internal use only.

Method Summary

IReportProcessingInfo.DataSourceLanguageLevel	getDataSourceLanguageLevel() For internal use only.
java.util.Locale	getFallbackLocale() Retrieve the fallback locale that will be used if no match is found for the requested run locale or language.
java.lang.String	getGroupFormula() Returns the group selection formula.
java.util.List	getProcessedLocales() For internal use only.
IReportProcessingExtensions	getProcessingSecurityExtensions() Returns the processing extensions collection for the report.
java.util.List	getPromptGroupMembers(java.lang.String groupID) Returns a collection of prompts that belong to the same group.
java.lang.String	getRecordFormula() Returns the record selection formula.
int	getReportAddProcType() For internal use only.
ISDKList	getReportAlerts() Returns a collection of IReportAlert objects.
int	getReportDefaultXMLExportSelection() Returns the 0-based index of the default XML export item in the list returned by getReportXMLInfo().
int	getReportEngineType() For internal use only.
IReportFormatOptions	getReportFormatOptions() Returns the IReportFormatOptions object, which can represent any supported export format.
java.util.List	getReportHyperlinks() Returns a collection of IReportHyperlink objects.
ISDKList	getReportLogons() Returns a collection that represents the database logon information for this object.
java.util.List	getReportParameters() Returns a collection of the IReportParameter objects.
IReportPrinterOptions	getReportPrinterOptions() Returns the printer options.
int	getReportSavedXMLExportSelection() Returns the 0-based index of the report saved XML export item in the list returned by getReportXMLInfo().
ISDKList	getReportXMLInfo() Returns a collection that contains the XML info items for this object.
java.util.List	getRunLocales() For internal use only.
java.util.Locale	getScheduledPVL() For internal use only.
int	getSchedulingNumPagesToGenerate() Return the number of cache pages to be generated.
int	getTotalPageCount() Return the number of formatted pages in a scheduled instance.
int	getViewingLOVShareInterval() Returns the the number of seconds that the LOV data will be shared.
int	getViewingShareInterval() Return the number of seconds that report data will be shared.
java.util.Set	getVisibleLocales() For internal use only.
boolean	hasDisplayCustomDBConfiguration() For internal use only.
boolean	hasDisplayOriginalDBConfiguration() For internal use only.
boolean	hasDynamicCascadePrompt() Returns a boolean that indicates whether this object has dynamic cascading prompts.
boolean	isLogonNeeded() Returns if this object needs access to a database that requires a logon.
boolean	isRepositoryEnabled() Returns whether or not the report can be updated from the report repository when adding or refreshing the report.
boolean	isRPTR() For internal use only.
boolean	isSchedulingEnableTotalPageCount() Returns a boolean indicating whether to generate and store the page count in the scheduled instance.
boolean	isSchedulingUseReportGenerateCacheSettings() Returns a boolean indicating whether to override the server setting on page cache generation.
boolean	isSchedulingUseReportPageCountSettings() Returns a boolean indicating whether to override the server setting on page count generation.
boolean	isViewingShareHitDBOnRefresh() Returns a boolean indicating whether a refresh request will hit the database to retrieve new data.
boolean	isViewingShareReport() Returns a boolean indicating whether report sharing is being used.
boolean	isViewingUseLOVCustomSharingSettings() Returns a boolean indicating if custom LOV sharing settings are being used.
boolean	isViewingUseReportSharingSettings() Returns whether or not report-specific sharing settings are being used.
void	queryRepositoryOptions() Deprecated.
void	setGroupFormula(java.lang.String groupFormula) Sets the group selection formula.
void	setLogonNeeded(boolean bNeedsLogon) Sets if this object needs access to a database that requires a logon.
void	setProcessedLocales(java.util.List processedLocales) For internal use only.
void	setRecordFormula(java.lang.String RecordFormula) Sets the record selection formula.
void	setReportAddProcType(int procType) For internal use only.
void	setRepositoryEnabled(boolean enabled) Sets whether or not the report can be updated from the report repository when adding or refreshing the report.
void	setRunLocales(java.util.List runLocales) For internal use only.
void	setSchedulingEnableTotalPageCount(boolean enablePageCount) Set whether to generate and store the page count in the scheduled instance.
void	setSchedulingNumPagesToGenerate(int numPages) Set the number of cache pages to be generated..
void	setSchedulingUseReportGenerateCacheSettings(boolean useReportSettings) Set whether to override the server setting on page cache generation.
void	setSchedulingUseReportPageCountSettings(boolean useReportSettings) Set whether to override the server setting on page count generation.
void	setViewingLOVShareInterval(int newVal) Sets the number of seconds that the LOV data will be shared.
void	setViewingShareHitDBOnRefresh(boolean hitDB) Sets whether a refresh request will hit the database to retrieve new data.
void	setViewingShareInterval(int newVal) Set the number of seconds that the report data will be shared.
void	setViewingShareReport(boolean bShareReport) Sets whether or not report sharing is being used.
void	setViewingUseLOVCustomSharingSettings(boolean useLOVCustomSpecificSharing) Sets custom sharing settings for LOV viewing.
void	setViewingUseReportSharingSettings(boolean useReportSpecificSharing) Sets specific sharing settings for report viewing.

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

Method Detail

isLogonNeeded

boolean isLogonNeeded()
                      throws SDKException

Returns if this object needs access to a database that requires a logon.

Returns:

true if this object needs access to a database that requires a logon, false otherwise.

Throws:

SDKException - Thrown if the process is unsuccessful.

setLogonNeeded

void setLogonNeeded(boolean bNeedsLogon)

Sets if this object needs access to a database that requires a logon.

Parameters:

bNeedsLogon - true if this object needs access to a database that requires a logon, false otherwise.

getReportLogons

ISDKList getReportLogons()
                         throws SDKException

Returns a collection that represents the database logon information for this object.

Returns:

A List of IReportLogon objects.

Throws:

SDKException - Thrown if the process is unsuccessful.

See Also:

IReportLogon

getRecordFormula

java.lang.String getRecordFormula()
                                  throws SDKException

Returns the record selection formula. This property is a String that stores the selection formula used to retrieve and filter records from the database.

Returns:

A String object that represents the record formula value.

Throws:

SDKException

setRecordFormula

void setRecordFormula(java.lang.String RecordFormula)

Sets the record selection formula. This property is a String that stores the selection formula used to retrieve and filter records from the database.

Parameters:

RecordFormula - A String object that specifies the record formula value.

getGroupFormula

java.lang.String getGroupFormula()
                                 throws SDKException

Returns the group selection formula. This property is a String that stores the selection formula used to retrieve and filter groups of records from the database.

Returns:

A String object that represents the group formula value.

Throws:

SDKException

setGroupFormula

void setGroupFormula(java.lang.String groupFormula)

Sets the group selection formula. This property is a String that stores the selection formula used to retrieve and filter groups of records from the database.

Parameters:

groupFormula - a String object that specifies the group formula value.

getReportFormatOptions

IReportFormatOptions getReportFormatOptions()

Returns the IReportFormatOptions object, which can represent any supported export format.

Returns:

An IReportFormatOptions object that represents the report format options value.

getReportPrinterOptions

IReportPrinterOptions getReportPrinterOptions()

Returns the printer options.

Returns:

An IReportPrinterOptions object that represents the report printer options value.

getProcessingSecurityExtensions

IReportProcessingExtensions getProcessingSecurityExtensions()

Returns the processing extensions collection for the report.

Returns:

An IReportProcessingExtensions object that contains the processing extensions collection for the report.

getReportParameters

java.util.List getReportParameters()
                                   throws SDKException

Returns a collection of the IReportParameter objects.

Returns:

A List object that represents the report parameters value.

Throws:

SDKException - Thrown if the process is unsuccessful.

See Also:

IReportParameter

hasDynamicCascadePrompt

boolean hasDynamicCascadePrompt()

Returns a boolean that indicates whether this object has dynamic cascading prompts.

Returns:

true if this object has dynamic cascading prompts, false otherwise.

getPromptGroupMembers

java.util.List getPromptGroupMembers(java.lang.String groupID)
                                     throws SDKException

Returns a collection of prompts that belong to the same group.

Parameters:

groupID - A String object that identifies the group ID.

Returns:

A List object that represents the prompt values for a specific group.

Throws:

SDKException - Thrown if the process is unsuccessful.

getReportAlerts

ISDKList getReportAlerts()
                         throws SDKException

Returns a collection of IReportAlert objects.

Returns:

A List object representing the report alerts values.

Throws:

SDKException - Thrown if the process is unsuccessful.

See Also:

IReportAlert

getReportHyperlinks

java.util.List getReportHyperlinks()
                                   throws SDKException

Returns a collection of IReportHyperlink objects.

Returns:

A List object representing the report hyperlinks.

Throws:

SDKException - Thrown if the process is unsuccessful.

See Also:

IReportHyperlink

isRepositoryEnabled

boolean isRepositoryEnabled()

Returns whether or not the report can be updated from the report repository when adding or refreshing the report.

Returns:

true if the report can be updated from the report repository when adding or refreshing the report, false otherwise.

setRepositoryEnabled

void setRepositoryEnabled(boolean enabled)

Sets whether or not the report can be updated from the report repository when adding or refreshing the report.

Parameters:

enabled - true if the report can be updated from the report repository when adding or refreshing the report, false otherwise.

queryRepositoryOptions

void queryRepositoryOptions()
                            throws SDKException

Deprecated.

Queries for repository options from the report global object. Use this method together with the IReportProcessingInfo.setRepositoryEnabled(boolean) method to refresh a report's repository objects. This method is also used when other report properties or methods need access to the global report object. The IReportGlobal object stores information about the user name and password which are used to access the repository in order to refresh the repository options.

Throws:

SDKException - Thrown if the process is unsuccessful.

isViewingUseLOVCustomSharingSettings

boolean isViewingUseLOVCustomSharingSettings()
                                             throws SDKException

Returns a boolean indicating if custom LOV sharing settings are being used.

Returns:

true if the custom LOV settings are being used, false otherwise.

Throws:

SDKException - Thrown if the process is unsuccessful.

setViewingUseLOVCustomSharingSettings

void setViewingUseLOVCustomSharingSettings(boolean useLOVCustomSpecificSharing)

Sets custom sharing settings for LOV viewing.

Parameters:

useLOVCustomSpecificSharing - A boolean specifying whether custom LOV sharing settings are being used.

getViewingLOVShareInterval

int getViewingLOVShareInterval()
                               throws SDKException

Returns the the number of seconds that the LOV data will be shared.

Returns:

An int indicating number of seconds that the LOV data will be shared.

Throws:

SDKException - Thrown if the process is unsuccessful.

setViewingLOVShareInterval

void setViewingLOVShareInterval(int newVal)

Sets the number of seconds that the LOV data will be shared.

Parameters:

newVal - An int specifying the number of seconds that the LOV data will be shared.

isViewingUseReportSharingSettings

boolean isViewingUseReportSharingSettings()
                                          throws SDKException

Returns whether or not report-specific sharing settings are being used.

Returns:

true if the sharing settings are being used, false otherwise.

Throws:

SDKException - Thrown if the process is unsuccessful.

setViewingUseReportSharingSettings

void setViewingUseReportSharingSettings(boolean useReportSpecificSharing)

Sets specific sharing settings for report viewing.

Parameters:

useReportSpecificSharing - A boolean specifying whether specific report sharing settings are being used.

isViewingShareReport

boolean isViewingShareReport()
                             throws SDKException

Returns a boolean indicating whether report sharing is being used.

Returns:

true if report sharing settings are being used, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setViewingShareReport

void setViewingShareReport(boolean bShareReport)

Sets whether or not report sharing is being used.

Parameters:

bShareReport - A boolean specifying whether report sharing is being used.

getViewingShareInterval

int getViewingShareInterval()
                            throws SDKException

Return the number of seconds that report data will be shared.

Returns:

An int indicating the number of seconds that the report data will be shared.

Throws:

SDKException - Thrown if the process is unsuccessful.

setViewingShareInterval

void setViewingShareInterval(int newVal)

Set the number of seconds that the report data will be shared.

Parameters:

newVal - An int specifying the number of seconds that the report data will be shared.

isViewingShareHitDBOnRefresh

boolean isViewingShareHitDBOnRefresh()
                                     throws SDKException

Returns a boolean indicating whether a refresh request will hit the database to retrieve new data.

Returns:

A boolean indicating whether a refresh request will hit the database to retrieve new data.

Throws:

SDKException - Thrown if the process is unsuccessful.

setViewingShareHitDBOnRefresh

void setViewingShareHitDBOnRefresh(boolean hitDB)

Sets whether a refresh request will hit the database to retrieve new data.

Parameters:

hitDB - A boolean specifying whether a refresh request will hit the database to retrieve new data.

getReportXMLInfo

ISDKList getReportXMLInfo()

Returns a collection that contains the XML info items for this object.

Returns:

A List of IReportXMLExportItem objects, or null if there is no XML export info stored in the report.

See Also:

IReportXMLExportItem

getReportDefaultXMLExportSelection

int getReportDefaultXMLExportSelection()

Returns the 0-based index of the default XML export item in the list returned by getReportXMLInfo().

Returns:

the 0-based index of the default XML export item in the list returned by getReportXMLInfo(), or -1 if no xml info is stored.

getReportSavedXMLExportSelection

int getReportSavedXMLExportSelection()

Returns the 0-based index of the report saved XML export item in the list returned by getReportXMLInfo().

Returns:

the 0-based index of the report saved XML export item in the list returned by getReportXMLInfo(), or -1 if no xml info is stored.

isSchedulingUseReportPageCountSettings

boolean isSchedulingUseReportPageCountSettings()
                                               throws SDKException

Returns a boolean indicating whether to override the server setting on page count generation.

Returns:

A boolean indicating whether to override the server setting on page count generation.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSchedulingUseReportPageCountSettings

void setSchedulingUseReportPageCountSettings(boolean useReportSettings)

Set whether to override the server setting on page count generation.

Parameters:

useReportSettings - A boolean specifying whether to override the server setting on page count generation.

isSchedulingEnableTotalPageCount

boolean isSchedulingEnableTotalPageCount()
                                         throws SDKException

Returns a boolean indicating whether to generate and store the page count in the scheduled instance.

Returns:

A boolean indicating whether to generate and store the page count in the scheduled instance.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSchedulingEnableTotalPageCount

void setSchedulingEnableTotalPageCount(boolean enablePageCount)

Set whether to generate and store the page count in the scheduled instance.

Parameters:

useReportSettings - A boolean specifying whether to generate and store the page count in the scheduled instance.

isSchedulingUseReportGenerateCacheSettings

boolean isSchedulingUseReportGenerateCacheSettings()
                                                   throws SDKException

Returns a boolean indicating whether to override the server setting on page cache generation.

Returns:

A boolean indicating whether to override the server setting on page cache generation.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSchedulingUseReportGenerateCacheSettings

void setSchedulingUseReportGenerateCacheSettings(boolean useReportSettings)

Set whether to override the server setting on page cache generation.

Parameters:

useReportSettings - A boolean specifying whether to override the server setting on page cache generation.

getSchedulingNumPagesToGenerate

int getSchedulingNumPagesToGenerate()
                                    throws SDKException

Return the number of cache pages to be generated.

Returns:

An int indicating the number of cache pages to be generated.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSchedulingNumPagesToGenerate

void setSchedulingNumPagesToGenerate(int numPages)

Set the number of cache pages to be generated..

Parameters:

newVal - An int specifying the number of cache pages to be generated.

getTotalPageCount

int getTotalPageCount()
                      throws SDKException

Return the number of formatted pages in a scheduled instance. This should be called only on scheduled instances and has a value when the page count settings are enabled at schedule time.

Returns:

An int indicating the number of formatted pages in the scheduled instance.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getReportEngineType

int getReportEngineType()

For internal use only.

isRPTR

boolean isRPTR()

For internal use only.

getVisibleLocales

java.util.Set getVisibleLocales()
                                throws SDKException

For internal use only.

Throws:

SDKException

setRunLocales

void setRunLocales(java.util.List runLocales)

For internal use only.

getRunLocales

java.util.List getRunLocales()

For internal use only.

getProcessedLocales

java.util.List getProcessedLocales()

For internal use only.

setProcessedLocales

void setProcessedLocales(java.util.List processedLocales)

For internal use only.

getFallbackLocale

java.util.Locale getFallbackLocale()

Retrieve the fallback locale that will be used if no match is found for the requested run locale or language.

Returns:

the report InfoObject's fallback locale.

getScheduledPVL

java.util.Locale getScheduledPVL()

For internal use only.

hasDisplayOriginalDBConfiguration

boolean hasDisplayOriginalDBConfiguration()
                                          throws SDKException

For internal use only.

Throws:

SDKException

hasDisplayCustomDBConfiguration

boolean hasDisplayCustomDBConfiguration()
                                        throws SDKException

For internal use only.

Throws:

SDKException

getDataSourceLanguageLevel

IReportProcessingInfo.DataSourceLanguageLevel getDataSourceLanguageLevel()

For internal use only.

getReportAddProcType

int getReportAddProcType()

For internal use only.

setReportAddProcType

void setReportAddProcType(int procType)

For internal use only.