com.businessobjects.enterprise.webi
Interface WebiProcessingInfo

All Superinterfaces:

DocumentProcessingInfo

public interface WebiProcessingInfo
extends DocumentProcessingInfo

The Web Intelligence document properties.

Nested Class Summary

static class

WebiProcessingInfo.Factory A class with methods for creating instances of the WebiProcessing type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

PrecacheTypes	addNewPrecacheTypes() Appends and returns a new empty PrecacheTypes object.
WebiPrompts	addNewPrompts() Appends and returns a new empty WebiPrompts object.
Universes	addNewUniverses() Appends and returns a new empty Universes object.
WebiFormatOptions	addNewWebiFormatOptions() Adds a new empty WebiFormatOptions object.
java.lang.String	getContentLocale() Gets the SI_CONTENT_LOCALE content locale.
boolean	getHasPrompts() Returns a boolean that indicates whether this Web Intelligence document contains prompts.
java.util.Calendar	getLastFileUpdateTimeStamp() Internal Use Only.
boolean	getPreCacheHTMLEnabled() Returns a boolean that indicates whether the HTML text stream that represents a Web Intelligence document will be pre-loaded into the cache.
boolean	getPreCachePDFEnabled() Returns a boolean that indicates whether the Portable Document Format (PDF) that represents a Web Intelligence document will be pre-loaded into the cache.
PrecacheTypes	getPrecacheTypes() Returns a collection of precache types that are available to this document.
boolean	getPreCacheXLSEnabled() 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	getPromptOnDemandViewing() Returns a boolean that indicates whether prompts are enabled for on-demand viewing.
WebiPrompts	getPrompts() Returns a collection of prompts that are associated with this Web Intelligence document.
boolean	getRefreshOnOpen() Internal Use Only.
Universes	getUniverses() Gets the IDs of the universes that are assigned to this Web Intelligence document.
java.lang.String	getUpdateObject() Internal Use Only.
java.lang.String	getUserInputLocaleName() Internal Use Only.
java.lang.String	getViewingServerGroup() Gets the ID of the server group for viewing the report.
ServerGroupChoiceEnum.Enum	getViewingServerGroupChoice() Gets how to choose the server group for viewing the report.
WebiFormatOptions	getWebiFormatOptions() Returns the document properties.
boolean	isSetContentLocale() Checks if the content locale has been set.
boolean	isSetLastFileUpdateTimeStamp() Internal Use Only.
boolean	isSetPreCacheHTMLEnabled() Checks if pre-loading the HTML text stream representing a Web Intelligence document into the cache has been set.
boolean	isSetPreCachePDFEnabled() Checks if pre-loading the PDF that represents a Web Intelligence document into the cache has been set.
boolean	isSetPrecacheTypes() Checks if the collection of precache types available to the document has been set.
boolean	isSetPreCacheXLSEnabled() Checks if pre-loading the Microsoft Excel format (XLS) that represents a Web Intelligence document has been set.
boolean	isSetPromptOnDemandViewing() Checks if the ability to prompt for on-demand viewing has been set.
boolean	isSetPrompts() Checks if the collection of prompts associated with the Web Intelligence document has been set.
boolean	isSetRefreshOnOpen() Internal Use Only.
boolean	isSetUpdateObject() Internal Use Only.
boolean	isSetUserInputLocaleName() Internal Use Only.
boolean	isSetViewingServerGroup() Checks if the ID of the server group for viewing the report has been set.
boolean	isSetViewingServerGroupChoice() Checks if how to choose the server group for viewing the report has been set.
boolean	isSetWebiFormatOptions() Checks if the document properties have been set.
void	setContentLocale(java.lang.String contentLocale) Sets the SI_CONTENT_LOCALE content locale.
void	setHasPrompts(boolean hasPrompts) Internal Use Only.
void	setLastFileUpdateTimeStamp(java.util.Calendar lastFileUpdateTimeStamp) Internal Use Only.
void	setPreCacheHTMLEnabled(boolean preCacheHTMLEnabled) 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 preCachePDFEnabled) 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	setPrecacheTypes(PrecacheTypes precacheTypes) Sets a collection of precache types that are available to this document.
void	setPreCacheXLSEnabled(boolean preCacheXLSEnabled) 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 promptOnDemandViewing) Sets a boolean that indicates whether prompts are enabled for on-demand viewing.
void	setPrompts(WebiPrompts prompts) Sets a collection of prompts that are associated with this Web Intelligence document.
void	setRefreshOnOpen(boolean refreshOnOpen) Internal Use Only.
void	setUniverses(Universes universes) Sets the IDs of the universes that are assigned to this Web Intelligence document.
void	setUpdateObject(java.lang.String updateObject) Internal Use Only.
void	setUserInputLocaleName(java.lang.String userInputLocaleName) Internal Use Only.
void	setViewingServerGroup(java.lang.String viewingServerGroup) Sets the ID of the server group for viewing the report.
void	setViewingServerGroupChoice(ServerGroupChoiceEnum.Enum viewingServerGroupChoice) Sets how to choose the server group for viewing the report.
void	setWebiFormatOptions(WebiFormatOptions webiFormatOptions) Sets the document properties.
void	unsetContentLocale() Deletes or unsets the ContentLocale element.
void	unsetLastFileUpdateTimeStamp() Internal Use Only.
void	unsetPreCacheHTMLEnabled() Deletes or unsets the PreCacheHTMLEnabled element.
void	unsetPreCachePDFEnabled() Deletes or unsets the PreCachePDFEnabled element.
void	unsetPrecacheTypes() Deletes or unsets the PrecacheTypes element.
void	unsetPreCacheXLSEnabled() Deletes or unsets the PreCacheXLSEnabled element.
void	unsetPromptOnDemandViewing() Deletes or unsets the PromptOnDemandViewing element.
void	unsetPrompts() Deletes or unsets the Prompts element.
void	unsetRefreshOnOpen() Internal Use Only.
void	unsetUpdateObject() Internal Use Only.
void	unsetUserInputLocaleName() Internal Use Only.
void	unsetViewingServerGroup() Deletes or unsets the ViewingServerGroup element.
void	unsetViewingServerGroupChoice() Deletes or unsets the ViewingServerGroupChoice element.
void	unsetWebiFormatOptions() Deletes or unsets the WebiFormatOptions element.
org.apache.xmlbeans.XmlString	xgetContentLocale() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetHasPrompts() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetLastFileUpdateTimeStamp() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPreCacheHTMLEnabled() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPreCachePDFEnabled() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPreCacheXLSEnabled() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPromptOnDemandViewing() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRefreshOnOpen() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetUpdateObject() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetUserInputLocaleName() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetViewingServerGroup() Internal Use Only.
ServerGroupChoiceEnum	xgetViewingServerGroupChoice() Internal Use Only.
void	xsetContentLocale(org.apache.xmlbeans.XmlString contentLocale) Internal Use Only.
void	xsetHasPrompts(org.apache.xmlbeans.XmlBoolean hasPrompts) Internal Use Only.
void	xsetLastFileUpdateTimeStamp(org.apache.xmlbeans.XmlDateTime lastFileUpdateTimeStamp) Internal Use Only.
void	xsetPreCacheHTMLEnabled(org.apache.xmlbeans.XmlBoolean preCacheHTMLEnabled) Internal Use Only.
void	xsetPreCachePDFEnabled(org.apache.xmlbeans.XmlBoolean preCachePDFEnabled) Internal Use Only.
void	xsetPreCacheXLSEnabled(org.apache.xmlbeans.XmlBoolean preCacheXLSEnabled) Internal Use Only.
void	xsetPromptOnDemandViewing(org.apache.xmlbeans.XmlBoolean promptOnDemandViewing) Internal Use Only.
void	xsetRefreshOnOpen(org.apache.xmlbeans.XmlBoolean refreshOnOpen) Internal Use Only.
void	xsetUpdateObject(org.apache.xmlbeans.XmlString updateObject) Internal Use Only.
void	xsetUserInputLocaleName(org.apache.xmlbeans.XmlString userInputLocaleName) Internal Use Only.
void	xsetViewingServerGroup(org.apache.xmlbeans.XmlString viewingServerGroup) Internal Use Only.
void	xsetViewingServerGroupChoice(ServerGroupChoiceEnum viewingServerGroupChoice) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getUniverses

Universes getUniverses()

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

Returns:

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

setUniverses

void setUniverses(Universes universes)

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

Parameters:

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

addNewUniverses

Universes addNewUniverses()

Appends and returns a new empty Universes object.

Returns:

An empty Universes object.

getLastFileUpdateTimeStamp

java.util.Calendar getLastFileUpdateTimeStamp()

Internal Use Only.

xgetLastFileUpdateTimeStamp

org.apache.xmlbeans.XmlDateTime xgetLastFileUpdateTimeStamp()

Internal Use Only.

isSetLastFileUpdateTimeStamp

boolean isSetLastFileUpdateTimeStamp()

Internal Use Only.

setLastFileUpdateTimeStamp

void setLastFileUpdateTimeStamp(java.util.Calendar lastFileUpdateTimeStamp)

Internal Use Only.

xsetLastFileUpdateTimeStamp

void xsetLastFileUpdateTimeStamp(org.apache.xmlbeans.XmlDateTime lastFileUpdateTimeStamp)

Internal Use Only.

unsetLastFileUpdateTimeStamp

void unsetLastFileUpdateTimeStamp()

Internal Use Only.

getWebiFormatOptions

WebiFormatOptions getWebiFormatOptions()

Returns the document properties.

Returns:

The document properties.

isSetWebiFormatOptions

boolean isSetWebiFormatOptions()

Checks if the document properties have been set.

Returns:

true if the document properties have been set, and false otherwise.

setWebiFormatOptions

void setWebiFormatOptions(WebiFormatOptions webiFormatOptions)

Sets the document properties.

Parameters:

webiFormatOptions - The document properties.

addNewWebiFormatOptions

WebiFormatOptions addNewWebiFormatOptions()

Adds a new empty WebiFormatOptions object.

Returns:

The new empty WebiFormatOptions object.

unsetWebiFormatOptions

void unsetWebiFormatOptions()

Deletes or unsets the WebiFormatOptions element.

getRefreshOnOpen

boolean getRefreshOnOpen()

Internal Use Only.

xgetRefreshOnOpen

org.apache.xmlbeans.XmlBoolean xgetRefreshOnOpen()

Internal Use Only.

isSetRefreshOnOpen

boolean isSetRefreshOnOpen()

Internal Use Only.

setRefreshOnOpen

void setRefreshOnOpen(boolean refreshOnOpen)

Internal Use Only.

xsetRefreshOnOpen

void xsetRefreshOnOpen(org.apache.xmlbeans.XmlBoolean refreshOnOpen)

Internal Use Only.

unsetRefreshOnOpen

void unsetRefreshOnOpen()

Internal Use Only.

getPromptOnDemandViewing

boolean getPromptOnDemandViewing()

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.

xgetPromptOnDemandViewing

org.apache.xmlbeans.XmlBoolean xgetPromptOnDemandViewing()

Internal Use Only.

isSetPromptOnDemandViewing

boolean isSetPromptOnDemandViewing()

Checks if the ability to prompt for on-demand viewing has been set.

Returns:

true if the PromptOnDemandViewing element has been set, and false otherwise.

setPromptOnDemandViewing

void setPromptOnDemandViewing(boolean promptOnDemandViewing)

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

Parameters:

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

xsetPromptOnDemandViewing

void xsetPromptOnDemandViewing(org.apache.xmlbeans.XmlBoolean promptOnDemandViewing)

Internal Use Only.

unsetPromptOnDemandViewing

void unsetPromptOnDemandViewing()

Deletes or unsets the PromptOnDemandViewing element.

getPreCacheXLSEnabled

boolean getPreCacheXLSEnabled()

Returns a boolean that indicates whether the Microsoft excel format (XLS) that represents a Web Intelligence document will be pre-loaded into the cache.

Returns:

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

xgetPreCacheXLSEnabled

org.apache.xmlbeans.XmlBoolean xgetPreCacheXLSEnabled()

Internal Use Only.

isSetPreCacheXLSEnabled

boolean isSetPreCacheXLSEnabled()

Checks if pre-loading the Microsoft Excel format (XLS) that represents a Web Intelligence document has been set.

Returns:

true if the PreCacheXLSEnabled element has been set, and false otherwise.

setPreCacheXLSEnabled

void setPreCacheXLSEnabled(boolean preCacheXLSEnabled)

Sets a boolean that indicates whether the Microsoft excel format (XLS) that represents a Web Intelligence document will be pre-loaded into the cache.

Parameters:

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

xsetPreCacheXLSEnabled

void xsetPreCacheXLSEnabled(org.apache.xmlbeans.XmlBoolean preCacheXLSEnabled)

Internal Use Only.

unsetPreCacheXLSEnabled

void unsetPreCacheXLSEnabled()

Deletes or unsets the PreCacheXLSEnabled element.

getPreCacheHTMLEnabled

boolean getPreCacheHTMLEnabled()

Returns a boolean that indicates whether the HTML text stream that represents a Web Intelligence document will be pre-loaded into the cache.

Returns:

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

xgetPreCacheHTMLEnabled

org.apache.xmlbeans.XmlBoolean xgetPreCacheHTMLEnabled()

Internal Use Only.

isSetPreCacheHTMLEnabled

boolean isSetPreCacheHTMLEnabled()

Checks if pre-loading the HTML text stream representing a Web Intelligence document into the cache has been set.

Returns:

true if the PreCacheHTMLEnabled element has been set, and false otherwise.

setPreCacheHTMLEnabled

void setPreCacheHTMLEnabled(boolean preCacheHTMLEnabled)

Sets a boolean that indicates whether the HTML text stream that represents a Web Intelligence document will be pre-loaded into the cache.

Parameters:

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

xsetPreCacheHTMLEnabled

void xsetPreCacheHTMLEnabled(org.apache.xmlbeans.XmlBoolean preCacheHTMLEnabled)

Internal Use Only.

unsetPreCacheHTMLEnabled

void unsetPreCacheHTMLEnabled()

Deletes or unsets the PreCacheHTMLEnabled element.

getPreCachePDFEnabled

boolean getPreCachePDFEnabled()

Returns a boolean that indicates whether the Portable Document Format (PDF) that represents a Web Intelligence document will be pre-loaded into the cache.

Returns:

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

xgetPreCachePDFEnabled

org.apache.xmlbeans.XmlBoolean xgetPreCachePDFEnabled()

Internal Use Only.

isSetPreCachePDFEnabled

boolean isSetPreCachePDFEnabled()

Checks if pre-loading the PDF that represents a Web Intelligence document into the cache has been set.

Returns:

true if the PreCachePDFEnabled element has been set, and false otherwise.

setPreCachePDFEnabled

void setPreCachePDFEnabled(boolean preCachePDFEnabled)

Sets a boolean that indicates whether the Portable Document Format (PDF) that represents a Web Intelligence document will be pre-loaded into the cache.

Parameters:

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

xsetPreCachePDFEnabled

void xsetPreCachePDFEnabled(org.apache.xmlbeans.XmlBoolean preCachePDFEnabled)

Internal Use Only.

unsetPreCachePDFEnabled

void unsetPreCachePDFEnabled()

Deletes or unsets the PreCachePDFEnabled element.

getContentLocale

java.lang.String getContentLocale()

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.

xgetContentLocale

org.apache.xmlbeans.XmlString xgetContentLocale()

Internal Use Only.

isSetContentLocale

boolean isSetContentLocale()

Checks if the content locale has been set.

Returns:

true if the ContentLocale element has been set, and false otherwise.

setContentLocale

void setContentLocale(java.lang.String contentLocale)

Sets the SI_CONTENT_LOCALE content locale.

Parameters:

contentLocale - A String that represents the SI_CONTENT_LOCALE content locale.

xsetContentLocale

void xsetContentLocale(org.apache.xmlbeans.XmlString contentLocale)

Internal Use Only.

unsetContentLocale

void unsetContentLocale()

Deletes or unsets the ContentLocale element.

getUserInputLocaleName

java.lang.String getUserInputLocaleName()

Internal Use Only.

xgetUserInputLocaleName

org.apache.xmlbeans.XmlString xgetUserInputLocaleName()

Internal Use Only.

isSetUserInputLocaleName

boolean isSetUserInputLocaleName()

Internal Use Only.

setUserInputLocaleName

void setUserInputLocaleName(java.lang.String userInputLocaleName)

Internal Use Only.

xsetUserInputLocaleName

void xsetUserInputLocaleName(org.apache.xmlbeans.XmlString userInputLocaleName)

Internal Use Only.

unsetUserInputLocaleName

void unsetUserInputLocaleName()

Internal Use Only.

getHasPrompts

boolean getHasPrompts()

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

Returns:

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

xgetHasPrompts

org.apache.xmlbeans.XmlBoolean xgetHasPrompts()

Internal Use Only.

setHasPrompts

void setHasPrompts(boolean hasPrompts)

Internal Use Only.

xsetHasPrompts

void xsetHasPrompts(org.apache.xmlbeans.XmlBoolean hasPrompts)

Internal Use Only.

getPrompts

WebiPrompts getPrompts()

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

Returns:

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

isSetPrompts

boolean isSetPrompts()

Checks if the collection of prompts associated with the Web Intelligence document has been set.

Returns:

true if the Prompts element has been set, and false otherwise.

setPrompts

void setPrompts(WebiPrompts prompts)

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

Parameters:

prompts - A collection of prompts that are associated with this Web Intelligence document.

addNewPrompts

WebiPrompts addNewPrompts()

Appends and returns a new empty WebiPrompts object.

Returns:

An empty WebiPrompts object.

unsetPrompts

void unsetPrompts()

Deletes or unsets the Prompts element.

getPrecacheTypes

PrecacheTypes getPrecacheTypes()

Returns a collection of precache types that are available to this document.

Returns:

A collection of precache types that are available to this document.

isSetPrecacheTypes

boolean isSetPrecacheTypes()

Checks if the collection of precache types available to the document has been set.

Returns:

true if the PrecacheTypes element has been set, and false otherwise.

setPrecacheTypes

void setPrecacheTypes(PrecacheTypes precacheTypes)

Sets a collection of precache types that are available to this document.

Parameters:

precacheTypes - A collection of precache types that are available to this document.

addNewPrecacheTypes

PrecacheTypes addNewPrecacheTypes()

Appends and returns a new empty PrecacheTypes object.

Returns:

An empty PrecacheTypes object.

unsetPrecacheTypes

void unsetPrecacheTypes()

Deletes or unsets the PrecacheTypes element.

getUpdateObject

java.lang.String getUpdateObject()

Internal Use Only.

xgetUpdateObject

org.apache.xmlbeans.XmlString xgetUpdateObject()

Internal Use Only.

isSetUpdateObject

boolean isSetUpdateObject()

Internal Use Only.

setUpdateObject

void setUpdateObject(java.lang.String updateObject)

Internal Use Only.

xsetUpdateObject

void xsetUpdateObject(org.apache.xmlbeans.XmlString updateObject)

Internal Use Only.

unsetUpdateObject

void unsetUpdateObject()

Internal Use Only.

getViewingServerGroupChoice

ServerGroupChoiceEnum.Enum getViewingServerGroupChoice()

Gets how to choose the server group for viewing the report.

Returns:

An enumeration that specifies the server group on which to run scheduled reports.

xgetViewingServerGroupChoice

ServerGroupChoiceEnum xgetViewingServerGroupChoice()

Internal Use Only.

isSetViewingServerGroupChoice

boolean isSetViewingServerGroupChoice()

Checks if how to choose the server group for viewing the report has been set.

Returns:

true if the ViewingServerGroupChoice element has been set, and false otherwise.

setViewingServerGroupChoice

void setViewingServerGroupChoice(ServerGroupChoiceEnum.Enum viewingServerGroupChoice)

Sets how to choose the server group for viewing the report.

Parameters:

viewingServerGroupChoice - Specifies the server group on which to run scheduled reports.

xsetViewingServerGroupChoice

void xsetViewingServerGroupChoice(ServerGroupChoiceEnum viewingServerGroupChoice)

Internal Use Only.

unsetViewingServerGroupChoice

void unsetViewingServerGroupChoice()

Deletes or unsets the ViewingServerGroupChoice element.

getViewingServerGroup

java.lang.String getViewingServerGroup()

Gets the ID of the server group for viewing the report.

Returns:

The ID of the server group for viewing the report.

xgetViewingServerGroup

org.apache.xmlbeans.XmlString xgetViewingServerGroup()

Internal Use Only.

isSetViewingServerGroup

boolean isSetViewingServerGroup()

Checks if the ID of the server group for viewing the report has been set.

Returns:

true if the ID of the server group for viewing the report has been set, and false otherwise.

setViewingServerGroup

void setViewingServerGroup(java.lang.String viewingServerGroup)

Sets the ID of the server group for viewing the report.

Parameters:

viewingServerGroup - The ID of the server group for viewing the report.

xsetViewingServerGroup

void xsetViewingServerGroup(org.apache.xmlbeans.XmlString viewingServerGroup)

Internal Use Only.

unsetViewingServerGroup

void unsetViewingServerGroup()

Deletes or unsets the ViewingServerGroup element.