com.businessobjects.sdk.plugin.desktop.webi
Interface IWebiProcessingInfo

All Superinterfaces:

IProcessingPublicationInfo, IViewingServerGroupInfo

All Known Subinterfaces:

IWebi, IWebiBase

public interface IWebiProcessingInfo
extends IViewingServerGroupInfo, IProcessingPublicationInfo

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

Method Summary

IPrecacheTypes	getPrecacheTypes() Returns the output formats and locales to pre-load into the cache when scheduling.
IWebiPrompts	getPrompts() Returns a collection of prompts that are associated with this Web Intelligence document.
java.lang.String	getUserInputLocaleName()
IWebiFormatOptions	getWebiFormatOptions() Returns the export format options for this Web Intelligence document.
boolean	hasPrompts() Returns a boolean that indicates whether this Web Intelligence document contains prompts.
boolean	isPreCacheHTMLEnabled() Returns a boolean that indicates whether the HTML text stream that represents a Web Intelligence document will be pre-loaded into the cache.
boolean	isPreCachePDFEnabled() Returns a boolean that indicates whether the Portable Document Format (PDF) that represents a Web Intelligence document will be pre-loaded into the cache.
boolean	isPreCacheXLSEnabled() Returns a boolean that indicates whether the Microsoft excel format (XLS) that represents a Web Intelligence document will be pre-loaded into the cache.
boolean	isPromptOnDemandViewing() Returns a boolean that indicates whether prompts are enabled for on-demand viewing.
void	setPreCacheHTMLEnabled(boolean bEnable) Sets a boolean that indicates whether the HTML text stream that represents a Web Intelligence document will be pre-loaded into the cache.
void	setPreCachePDFEnabled(boolean bEnable) Sets a boolean that indicates whether the Portable Document Format (PDF) that represents a Web Intelligence document will be pre-loaded into the cache.
void	setPreCacheXLSEnabled(boolean bEnable) Sets a boolean that indicates whether the Microsoft excel format (XLS) that represents a Web Intelligence document will be pre-loaded into the cache.
void	setPromptOnDemandViewing(boolean bPromptOnDemand) Sets a boolean that indicates whether prompts are enabled for on-demand viewing.
void	setUserInputLocaleName(java.lang.String aLocaleName)

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

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

Method Detail

isPreCacheHTMLEnabled

boolean isPreCacheHTMLEnabled()
                              throws SDKException

Returns a boolean that indicates whether the HTML text stream that represents a Web Intelligence document will be pre-loaded into the cache. This method returns the value for the SI_PRECACHE_HTML property.

The HTML text stream can be cached in the Web Intelligence Report Server’s document cache when the document is scheduled or viewed. This is determined by whether the isDocExpressEnabled or the isDocExpressRealTimeCachingEnabled is set to true.

For more information see IWebiServerAdmin.

Returns:

true if the HTML format will be pre-loaded into the cache, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPreCacheHTMLEnabled

void setPreCacheHTMLEnabled(boolean bEnable)

Sets a boolean that indicates whether the HTML text stream that represents a Web Intelligence document will be pre-loaded into the cache. This method sets the value for the SI_PRECACHE_HTML property.

The HTML text stream can be cached in the Web Intelligence Report Server’s document cache when the document is scheduled or viewed. This is determined by whether the isDocExpressEnabled or the isDocExpressRealTimeCachingEnabled is set to true.

For more information see IWebiServerAdmin.

Parameters:

bEnable - A boolean that indicates whether the HTML format will be preloaded into the cache.

isPreCachePDFEnabled

boolean isPreCachePDFEnabled()
                             throws SDKException

Returns a boolean that indicates whether the Portable Document Format (PDF) that represents a Web Intelligence document will be pre-loaded into the cache. This method returns the value for the SI_PRECACHE_PDF property.

The PDFcan be cached in the Web Intelligence Report Server’s document cache when the document is scheduled or viewed. This is determined by whether the isDocExpressEnabled or the isDocExpressRealTimeCachingEnabled is set to true.

For more information see IWebiServerAdmin.

Returns:

true if the PDF format will be pre-loaded into the cache, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPreCachePDFEnabled

void setPreCachePDFEnabled(boolean bEnable)

Sets a boolean that indicates whether the Portable Document Format (PDF) that represents a Web Intelligence document will be pre-loaded into the cache. This method sets the value for the SI_PRECACHE_PDF property.

The PDFcan be cached in the Web Intelligence Report Server’s document cache when the document is scheduled or viewed. This is determined by whether the isDocExpressEnabled or the isDocExpressRealTimeCachingEnabled is set to true.

For more information see IWebiServerAdmin.

Parameters:

bEnable - A boolean that indicates whether the PDF format will be preloaded into the cache.

isPreCacheXLSEnabled

boolean isPreCacheXLSEnabled()
                             throws SDKException

Returns a boolean that indicates whether the Microsoft excel format (XLS) that represents a Web Intelligence document will be pre-loaded into the cache. This method returns the value for the SI_PRECACHE_XLS property.

The XLS format can be cached in the Web Intelligence Report Server’s document cache when the document is scheduled or viewed. This is determined by whether the isDocExpressEnabled or the isDocExpressRealTimeCachingEnabled is set to true.

For more information see IWebiServerAdmin.

Returns:

true if the XLS format will be pre-loaded into the cache, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPreCacheXLSEnabled

void setPreCacheXLSEnabled(boolean bEnable)

Sets a boolean that indicates whether the Microsoft excel format (XLS) that represents a Web Intelligence document will be pre-loaded into the cache. This method sets the value for the SI_PRECACHE_XLS property.

The XLS format can be cached in the Web Intelligence Report Server’s document cache when the document is scheduled or viewed. This is determined by whether the isDocExpressEnabled or the isDocExpressRealTimeCachingEnabled is set to true.

For more information see IWebiServerAdmin.

Parameters:

bEnable - A boolean that indicates whether the XLS format will be preloaded into the cache.

getPrecacheTypes

IPrecacheTypes getPrecacheTypes()
                                throws SDKException

Returns the output formats and locales to pre-load into the cache when scheduling.

Returns:

An IPrecacheTypes collection that represents the pre-loaded formats and locales.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getWebiFormatOptions

IWebiFormatOptions getWebiFormatOptions()

Returns the export format options for this Web Intelligence document.

Returns:

An IWebiFormatOptions object that represents the format options.

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 - Aboolean that indicates whether prompting should be enabled for on-demand viewing requests.

hasPrompts

boolean hasPrompts()
                   throws SDKException

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

Returns:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPrompts

IWebiPrompts getPrompts()
                        throws SDKException

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

Returns:

A List object that represents the prompt values.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getUserInputLocaleName

java.lang.String getUserInputLocaleName()
                                        throws SDKException

Throws:

SDKException

setUserInputLocaleName

void setUserInputLocaleName(java.lang.String aLocaleName)
                            throws SDKException

Throws:

SDKException