com.businessobjects.sdk.plugin.desktop.fullclient
Interface IFullClientProcessingInfo

All Superinterfaces:

ICacheServerGroupInfo, IProcessingPublicationInfo, IProcessingServerGroupInfo

All Known Subinterfaces:

IFullClient, IFullClientBase

public interface IFullClientProcessingInfo
extends IProcessingServerGroupInfo, ICacheServerGroupInfo, IProcessingPublicationInfo

This interface provides methods which allow you to manage options for a Desktop Intelligence document that are specific to prompts and pre-loading the Desktop Intelligence Report Server's document cache with specific document formats.

Method Summary

IFullClientPrinterOptions	getFullClientPrinterOptions() Returns the printer options associated with this Desktop Intelligence document.
IFullClientPrompts	getPrompts() Returns a collection of prompts that are associated with this Desktop Intelligence document.
int	getViewingShareInterval() Returns the report sharing interval value in seconds.
boolean	hasPrompts() Returns a boolean that indicates whether this Desktop Intelligence document contains prompts.
boolean	isPromptOnDemandViewing() Returns a boolean that indicates whether prompts are enabled for on-demand viewing.
boolean	isViewingShareHitDBOnRefresh() Returns a boolean indicating whether a refresh request will hit the database to retrieve new data.
boolean	isViewingShareReport() Returns a boolean that indicates whether report sharing is used.
boolean	isViewingUseReportSharingSettings() Returns a boolean that indicates whether specific report sharing settings are used.
void	setPromptOnDemandViewing(boolean bPromptOnDemand) Sets a boolean that indicates whether prompts are enabled for on-demand viewing.
void	setViewingShareHitDBOnRefresh(boolean hitDB) Sets whether a refresh request will hit the database to retrieve new data.
void	setViewingShareInterval(int newVal) Sets the report sharing interval value in seconds.
void	setViewingShareReport(boolean bShareReport) Sets a boolean that indicates whether report sharing is used.
void	setViewingUseReportSharingSettings(boolean useReportSpecificSharing) Sets a boolean that indicates whether specific report sharing settings are used.

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

isPromptOnDemandViewing

boolean isPromptOnDemandViewing()
                                throws SDKException

Returns a boolean that indicates whether prompts are enabled for on-demand viewing.

Returns:

true if prompts are enabled for on-demand viewing, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPromptOnDemandViewing

void setPromptOnDemandViewing(boolean bPromptOnDemand)

Sets a boolean that indicates whether prompts are enabled for on-demand viewing.

Parameters:

bPromptOnDemand - A boolean that indicates whether prompting should be enabled for on-demand viewing requests.

hasPrompts

boolean hasPrompts()
                   throws SDKException

Returns a boolean that indicates whether this Desktop Intelligence document contains prompts.

Returns:

true if the Desktop Intelligence document contains prompts, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPrompts

IFullClientPrompts getPrompts()
                              throws SDKException

Returns a collection of prompts that are associated with this Desktop Intelligence document.

Returns:

An IFullClientPrompts object that represents the prompt values.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFullClientPrinterOptions

IFullClientPrinterOptions getFullClientPrinterOptions()
                                                      throws SDKException

Returns the printer options associated with this Desktop Intelligence document.

Returns:

An IFullClientPrinterOptions object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isViewingUseReportSharingSettings

boolean isViewingUseReportSharingSettings()
                                          throws SDKException

Returns a boolean that indicates whether specific report sharing settings are used.

Returns:

true if specific report share settings are used, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setViewingUseReportSharingSettings

void setViewingUseReportSharingSettings(boolean useReportSpecificSharing)

Sets a boolean that indicates whether specific report sharing settings are used.

Parameters:

useReportSpecificSharing - A boolean that indicates whether specific report sharing settings are used.

isViewingShareReport

boolean isViewingShareReport()
                             throws SDKException

Returns a boolean that indicates whether report sharing is used.

Returns:

A boolean that indicates whether report sharing is used.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setViewingShareReport

void setViewingShareReport(boolean bShareReport)

Sets a boolean that indicates whether report sharing is used.

Parameters:

bShareReport - A boolean that indicates whether report sharing is used.

getViewingShareInterval

int getViewingShareInterval()
                            throws SDKException

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

Returns:

An int that indicates the report sharing interval value in seconds.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setViewingShareInterval

void setViewingShareInterval(int newVal)

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

Parameters:

newVal - An int that indicates the report sharing interval value in seconds.

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 - This is 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.