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

All Superinterfaces:

IProcessingPublicationInfo, IViewingServerGroupInfo, IWebiProcessingInfo

All Known Subinterfaces:

IWebi

public interface IWebiBase
extends IWebiProcessingInfo

This interface inherits from IWebiProcessingInfo and it also provides a method which allows you to retrieve the ID's of the universes that are associated with a Webi object.

Method Summary

void	clearWebiObjectRelatives()
int	getAutosaveOriginalDocID() Gets the SI_AUTOSAVE_ORIGINAL_DOCID original doc ID.
java.lang.String	getContentLocale() Gets the SI_CONTENT_LOCALE content locale.
java.util.List	getDocL10NLocales() Gets String[] defined into SI_WEBI_DOC_PROPERTIES.
IWebiDocDataProviders	getDocumentDataProviders() Gets IWebiDocDataProviders defined into SI_WEBI_DOC_PROPERTIES.
IWebiDocPrompts	getDocumentPrompts() Gets IWebiDocPrompts defined into SI_WEBI_DOC_PROPERTIES.
IWebiDocProperties	getDocumentProperties() Gets properties defined into SI_WEBI_DOC_PROPERTIES.
java.lang.String	getDocumentPropertiesVersion() Gets version of xml stored into SI_WEBI_DOC_PROPERTIES.
java.util.Set	getDSLUniverses() Gets the IDs of the DSL universes that are assigned to this Web Intelligence document.
java.util.Set	getFHSQLConnection() Gets the IDs of the connection that are assigned to this Web Intelligence document.
java.util.Set	getUniverses() Gets the IDs of the universes that are assigned to this Web Intelligence document.
java.util.Set	getWebiObjectRelatives(java.lang.String propName)
void	setAutosaveOriginalDocID(int originalDocID) Sets the SI_AUTOSAVE_ORIGINAL_DOCID original doc ID.
void	setContentLocale(java.lang.String s) Sets the SI_CONTENT_LOCALE content locale.
void	setDocL10NLocales(java.util.Locale[] locales) Overrides locales String[] to be saved into SI_WEBI_DOC_PROPERTIES.

Methods inherited from interface com.businessobjects.sdk.plugin.desktop.webi.IWebiProcessingInfo

getPrecacheTypes, getPrompts, getUserInputLocaleName, getWebiFormatOptions, hasPrompts, isPreCacheHTMLEnabled, isPreCachePDFEnabled, isPreCacheXLSEnabled, isPromptOnDemandViewing, setPreCacheHTMLEnabled, setPreCachePDFEnabled, setPreCacheXLSEnabled, setPromptOnDemandViewing, setUserInputLocaleName

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

getUniverses

java.util.Set getUniverses()
                           throws SDKException

Gets the IDs of the universes that are assigned to this Web Intelligence document.

Returns:

A Set of IDs corresponding to the Universes that belong to the current Webi.

Throws:

SDKException - Throws exception if property is not found

See Also:

IUniverseBase

getFHSQLConnection

java.util.Set getFHSQLConnection()
                                 throws SDKException

Gets the IDs of the connection that are assigned to this Web Intelligence document.

Returns:

A Set of IDs corresponding to the connection that belong to the current Webi.

Throws:

SDKException - Throws exception if property is not found

See Also:

IUniverseBase

getDSLUniverses

java.util.Set getDSLUniverses()
                              throws SDKException

Gets the IDs of the DSL universes that are assigned to this Web Intelligence document.

Returns:

A Set of IDs corresponding to the DSL Universes that belong to the current Webi.

Throws:

SDKException - Throws exception if property is not found

getContentLocale

java.lang.String getContentLocale()
                                  throws SDKException

Gets the SI_CONTENT_LOCALE content locale.

Returns:

A String that represents the SI_CONTENT_LOCALE content locale. If the property is not present, an empty String is returned.

Throws:

SDKException - Throws exception if property is not found.

setContentLocale

void setContentLocale(java.lang.String s)
                      throws SDKException

Sets the SI_CONTENT_LOCALE content locale.

Parameters:

s - A String that represents the SI_CONTENT_LOCALE content locale.

Throws:

SDKException - Throws exception if property is not found.

getAutosaveOriginalDocID

int getAutosaveOriginalDocID()
                             throws SDKException

Gets the SI_AUTOSAVE_ORIGINAL_DOCID original doc ID.

Returns:

A String that represents the SI_AUTOSAVE_ORIGINAL_DOCID original doc ID.

Throws:

SDKException - Throws exception if property is not found.

setAutosaveOriginalDocID

void setAutosaveOriginalDocID(int originalDocID)
                              throws SDKException

Sets the SI_AUTOSAVE_ORIGINAL_DOCID original doc ID.

Parameters:

s - A String that represents the SI_AUTOSAVE_ORIGINAL_DOCID original doc ID. If the property is not present, 0 is returned.

Throws:

SDKException - Throws exception if property is not found.

getDocumentProperties

IWebiDocProperties getDocumentProperties()
                                         throws SDKException

Gets properties defined into SI_WEBI_DOC_PROPERTIES.

Returns:

IWebiDocProperties

Throws:

java.lang.Exception

SDKException

getDocumentPrompts

IWebiDocPrompts getDocumentPrompts()
                                   throws SDKException

Gets IWebiDocPrompts defined into SI_WEBI_DOC_PROPERTIES.

Returns:

IWebiDocPrompts

Throws:

java.lang.Exception

SDKException

getDocumentDataProviders

IWebiDocDataProviders getDocumentDataProviders()
                                               throws SDKException

Gets IWebiDocDataProviders defined into SI_WEBI_DOC_PROPERTIES.

Returns:

IWebiDocDataProviders

Throws:

SDKException

java.lang.Exception

getDocL10NLocales

java.util.List getDocL10NLocales()
                                 throws SDKException

Gets String[] defined into SI_WEBI_DOC_PROPERTIES.

Returns:

String[]

Throws:

SDKException

java.lang.Exception

setDocL10NLocales

void setDocL10NLocales(java.util.Locale[] locales)
                       throws SDKException

Overrides locales String[] to be saved into SI_WEBI_DOC_PROPERTIES.

Throws:

SDKException

java.lang.Exception

getDocumentPropertiesVersion

java.lang.String getDocumentPropertiesVersion()
                                              throws SDKException

Gets version of xml stored into SI_WEBI_DOC_PROPERTIES.

Returns:

xml version.

Throws:

SDKException

getWebiObjectRelatives

java.util.Set getWebiObjectRelatives(java.lang.String propName)
                                     throws SDKException

Throws:

SDKException

clearWebiObjectRelatives

void clearWebiObjectRelatives()
                              throws SDKException

Throws:

SDKException