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

All Superinterfaces:

IViewingServerGroupInfo

All Known Subinterfaces:

IReport, IReportBase

public interface IReportProcessingInfo

extends IViewingServerGroupInfo

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

Method Summary

java.lang.String	getGroupFormula() Returns the group selection formula.
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.
ISDKList	getReportAlerts() Returns a collection of IReportAlert.
IReportFormatOptions	getReportFormatOptions() Returns the IReportFormatOptions object, which can represent any supported export format.
java.util.List	getReportHyperlinks() Returns a collection of IReportHyperlink.
ISDKList	getReportLogons() Returns a collection object that represents the database logon information for this object.
java.util.List	getReportParameters() Returns a collection of the IReportParameter.
IReportPrinterOptions	getReportPrinterOptions() Returns the printer options.
int	getViewingShareInterval() Return the sharing interval value.
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 the report can be updated from the report repository when adding or refreshing the report.
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	isViewingUseReportSharingSettings() Returns a boolean indicating if 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	setRecordFormula(java.lang.String RecordFormula) Sets the record selection formula.
void	setRepositoryEnabled(boolean enabled) Sets whether the report can be updated from the report repository when adding or refreshing the report.
void	setViewingShareHitDBOnRefresh(boolean hitDB) Sets whether a refresh request will hit the database to retrieve new data.
void	setViewingShareInterval(int newVal) Set the sharing interval.
void	setViewingShareReport(boolean bShareReport) Set whether report sharing will be used.
void	setViewingUseReportSharingSettings(boolean useReportSpecificSharing) Set specific share settings for report viewing.

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

getViewingServerGroup, getViewingServerGroupChoice, setViewingServerGroup, setViewingServerGroupChoice

Method Detail

isLogonNeeded

public 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.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setLogonNeeded

public 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.

getReportLogons

public ISDKList getReportLogons()
                         throws SDKException

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

Returns:

A List of IReportLogon objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportLogon

getRecordFormula

public java.lang.String getRecordFormula()
                                  throws SDKException

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

Returns:

A String representing the record formula value.

Throws:

SDKException

setRecordFormula

public void setRecordFormula(java.lang.String RecordFormula)

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

Parameters:

RecordFormula - A String specifying the record formula value.

getGroupFormula

public java.lang.String getGroupFormula()
                                 throws SDKException

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

Returns:

A String representing the group formula value.

Throws:

SDKException

setGroupFormula

public void setGroupFormula(java.lang.String groupFormula)

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

Parameters:

groupFormula - a String specifying the group formula value.

getReportFormatOptions

public IReportFormatOptions getReportFormatOptions()

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

Returns:

An IReportFormatOptions object representing the report format options value.

getReportPrinterOptions

public IReportPrinterOptions getReportPrinterOptions()

Returns the printer options.

Returns:

An IReportPrinterOptions object representing the report printer options value.

getProcessingSecurityExtensions

public IReportProcessingExtensions getProcessingSecurityExtensions()

Returns the Processing Extensions collection for the report.

Returns:

An IReportProcessingExtensions object containing the ProcessingExtensions collection for the report.

getReportParameters

public java.util.List getReportParameters()
                                   throws SDKException

Returns a collection of the IReportParameter.

Returns:

A List object representing the report parameters value.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportParameter

hasDynamicCascadePrompt

public boolean hasDynamicCascadePrompt()

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

Returns:

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

getPromptGroupMembers

public 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 that identifies the group ID.

Returns:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

getReportAlerts

public ISDKList getReportAlerts()
                         throws SDKException

Returns a collection of IReportAlert.

Returns:

A List object representing the report alerts values.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportAlert

getReportHyperlinks

public java.util.List getReportHyperlinks()
                                   throws SDKException

Returns a collection of IReportHyperlink.

Returns:

A List object representing the report hyperlinks.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IReportHyperlink

isRepositoryEnabled

public boolean isRepositoryEnabled()

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

See the BusinessObjects Enterprise Administrator's Help for more information about the BusinessObjects Enterprise Repository. The help can be accessed through the BusinessObjects Enterprise Launchpad.

Returns:

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

setRepositoryEnabled

public void setRepositoryEnabled(boolean enabled)

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

See the BusinessObjects Enterprise Administrator's Help for more information about the BusinessObjects Enterprise Repository. The help can be accessed through the BusinessObjects Enterprise Launchpad.

Parameters:

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

queryRepositoryOptions

public 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 - This is thrown if the process is unsuccessful.

isViewingUseReportSharingSettings

public boolean isViewingUseReportSharingSettings()
                                          throws SDKException

Returns a boolean indicating if report specific sharing settings are being used.

Returns:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

setViewingUseReportSharingSettings

public void setViewingUseReportSharingSettings(boolean useReportSpecificSharing)

Set specific share settings for report viewing.

Parameters:

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

isViewingShareReport

public boolean isViewingShareReport()
                             throws SDKException

Returns a boolean indicating whether report sharing is being used.

Returns:

A boolean indicating whether report sharing is being used

Throws:

SDKException - This is thrown if the process is unsuccessful.

setViewingShareReport

public void setViewingShareReport(boolean bShareReport)

Set whether report sharing will be used.

Parameters:

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

getViewingShareInterval

public int getViewingShareInterval()
                            throws SDKException

Return the sharing interval value. This time interval indicates (in seconds) how long the report data will be shared.

Returns:

An int indicating the time (in seconds) that the report data will be shared.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setViewingShareInterval

public void setViewingShareInterval(int newVal)

Set the sharing interval. This time interval indicates (in seconds) how long the report data will be shared.

Parameters:

newVal - An int specifying the time (in seconds) that the report data will be shared.

isViewingShareHitDBOnRefresh

public 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 - This is thrown if the process is unsuccessful.

setViewingShareHitDBOnRefresh

public 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.