com.businessobjects.enterprise.fullclient
Interface FullClientProcessingInfo

All Superinterfaces:

DocumentProcessingInfo

public interface FullClientProcessingInfo
extends DocumentProcessingInfo

The Desktop Intelligence document properties.

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

com.businessobjects.enterprise.fullclient.FullClientDataProviders	addNewFullClientDataProviders() Appends and returns a new empty FullClientDataProviders object to the last element of the array.
FullClientFormatOptions	addNewFullClientFormatOptions() Appends and returns a new empty FullClientFormatOptions object to the last element of the array.
FullClientPrinterOptions	addNewFullClientPrinterOptions() Appends and returns a new empty FullClientPrinterOptions object to the last element of the array.
FullClientPrompts	addNewPrompts() Appends and returns a new empty FullClientPrompts object to the last element of the array.
Publications	addNewPublications() Appends and returns a new empty Publications object to the last element of the array.
Universes	addNewUniverses() Appends and returns a new empty Publications object to the last element of the array.
java.lang.String	getAuthor() Returns the document owner.
java.lang.String	getCacheServerGroup() Gets the ID of the server group for Caching the report.
ServerGroupChoiceEnum.Enum	getCacheServerGroupChoice() Gets how to choose the server group for Caching the report.
java.lang.String	getComments() Returns the document comments.
com.businessobjects.enterprise.fullclient.FullClientDocTypeEnum.Enum	getDocType() Internal Use Only.
com.businessobjects.enterprise.fullclient.FullClientDataProviders	getFullClientDataProviders() Internal Use Only.
FullClientFormatOptions	getFullClientFormatOptions() Returns the export format options.
FullClientPrinterOptions	getFullClientPrinterOptions() Returns the printer options associated with this Desktop Intelligence document.
boolean	getHasPrompts() Returns a boolean that indicates whether this Desktop Intelligence document contains prompts.
boolean	getHasVbaMacrosInside() Returns a boolean that indicates whether this document contains Visual Basic for Applications macros.
java.util.Calendar	getLastActionDate() Internal Use Only.
java.util.Calendar	getLastPrintDate() Internal Use Only.
int	getNbReports() Internal Use Only.
boolean	getPreCacheHTMLEnabled() Returns a boolean that indicates whether the HTML text stream that represents a Desktop 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 Desktop Intelligence document will be pre-loaded into the cache.
boolean	getPreCacheXLSEnabled() Returns a boolean that indicates whether the Microsoft excel format (XLS) that represents a Desktop Intelligence document will be pre-loaded into the cache.
java.lang.String	getProcessingServerGroup() Gets the ID of the server group for Processing the report.
ServerGroupChoiceEnum.Enum	getProcessingServerGroupChoice() Gets how to choose the server group for Processing the report.
boolean	getPromptOnDemandViewing() Returns a boolean that indicates whether prompts are enabled for on-demand viewing.
FullClientPrompts	getPrompts() Returns a collection of prompts that are associated with this Desktop Intelligence document.
Publications	getPublications() Returns the collection of publication IDs that use this document.
boolean	getRefreshOnOpen() Returns a boolean that indicates whether this document refreshes on open.
int	getRevisionNumber() Internal Use Only.
int	getSize() Internal Use Only.
java.lang.String	getSubject() Returns the document subject.
Universes	getUniverses() Returns the IDs of the universes that are assigned to this Desktop Intelligence document.
boolean	getViewingShareHitDBOnRefresh() A boolean indicating whether the viewer refresh hits the database.
int	getViewingShareInterval() Return the sharing interval value.
boolean	getViewingShareReport() Returns a boolean indicating whether report sharing is being used.
boolean	getViewingUseReportSharingSettings() Returns a boolean indicating if report specific sharing settings are being used.
boolean	isSetAuthor() Checks if the Author has been set.
boolean	isSetCacheServerGroup() Checks if the CacheServerGroup has been set.
boolean	isSetCacheServerGroupChoice() Checks if the CacheServerGroupChoice has been set.
boolean	isSetComments() Checks if the Comments has been set.
boolean	isSetDocType() Internal Use Only.
boolean	isSetFullClientDataProviders() Checks if the FullClientDataProviders has been set.
boolean	isSetFullClientFormatOptions() Checks if the FullClientFormatOptions has been set.
boolean	isSetFullClientPrinterOptions() Checks if the FullClientPrinterOptions has been set.
boolean	isSetHasPrompts() Checks if the HasPrompts has been set.
boolean	isSetHasVbaMacrosInside() Checks if the HasVbaMacrosInside has been set.
boolean	isSetLastActionDate() Internal Use Only.
boolean	isSetLastPrintDate() Internal Use Only.
boolean	isSetNbReports() Internal Use Only.
boolean	isSetPreCacheHTMLEnabled() Checks if the PreCacheHTMLEnabled has been set.
boolean	isSetPreCachePDFEnabled() Checks if the PreCachePDFEnabled has been set.
boolean	isSetPreCacheXLSEnabled() Checks if the PreCacheXLSEnabled element has been set.
boolean	isSetProcessingServerGroup() Checks if the ProcessingServerGroup has been set.
boolean	isSetProcessingServerGroupChoice() Checks if the ProcessingServerGroupChoice has been set.
boolean	isSetPromptOnDemandViewing() Checks if the PromptOnDemandViewing has been set.
boolean	isSetPrompts() Checks if the Prompts has been set.
boolean	isSetPublications() Checks if the Publications has been set.
boolean	isSetRefreshOnOpen() Checks if the RefreshOnOpen has been set.
boolean	isSetRevisionNumber() Internal Use Only.
boolean	isSetSize() Internal Use Only.
boolean	isSetSubject() Checks if the Subject element has been set.
boolean	isSetUniverses() Checks if the Universes has been set.
boolean	isSetViewingShareHitDBOnRefresh() Checks if the ViewingShareHitDBOnRefresh has been set.
boolean	isSetViewingShareInterval() Checks if the ViewingShareInterval element has been set.
boolean	isSetViewingShareReport() Checks if the ViewingShareReport has been set.
boolean	isSetViewingUseReportSharingSettings() Checks if the ViewingUseReportSharingSettings element has been set.
void	setAuthor(java.lang.String author) Sets the document owner.
void	setCacheServerGroup(java.lang.String cacheServerGroup) Sets the ID of the server group for Caching the report.
void	setCacheServerGroupChoice(ServerGroupChoiceEnum.Enum cacheServerGroupChoice) Sets how to choose the server group for Caching the report.
void	setComments(java.lang.String comments) Sets the document comments.
void	setDocType(com.businessobjects.enterprise.fullclient.FullClientDocTypeEnum.Enum docType) Internal Use Only.
void	setFullClientDataProviders(com.businessobjects.enterprise.fullclient.FullClientDataProviders fullClientDataProviders) Internal Use Only.
void	setFullClientFormatOptions(FullClientFormatOptions fullClientFormatOptions) Sets the export format options.
void	setFullClientPrinterOptions(FullClientPrinterOptions fullClientPrinterOptions) Sets the printer options associated with this Desktop Intelligence document.
void	setHasPrompts(boolean hasPrompts) Internal Use Only.
void	setHasVbaMacrosInside(boolean hasVbaMacrosInside) Sets a boolean that indicates whether this document contains Visual Basic for Applications macros.
void	setLastActionDate(java.util.Calendar lastActionDate) Internal Use Only.
void	setLastPrintDate(java.util.Calendar lastPrintDate) Internal Use Only.
void	setNbReports(int nbReports) Internal Use Only.
void	setPreCacheHTMLEnabled(boolean preCacheHTMLEnabled) Sets a boolean that indicates whether the HTML text stream that represents a Desktop 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 Desktop Intelligence document will be pre-loaded into the cache.
void	setPreCacheXLSEnabled(boolean preCacheXLSEnabled) Sets a boolean that indicates whether the Microsoft excel format (XLS) that represents a Desktop Intelligence document will be pre-loaded into the cache.
void	setProcessingServerGroup(java.lang.String processingServerGroup) Sets the ID of the server group for Processing the report.
void	setProcessingServerGroupChoice(ServerGroupChoiceEnum.Enum processingServerGroupChoice) Sets how to choose the server group for Processing the report.
void	setPromptOnDemandViewing(boolean promptOnDemandViewing) Sets a boolean that indicates whether prompts are enabled for on-demand viewing.
void	setPrompts(FullClientPrompts prompts) Sets a collection of prompts that are associated with this Desktop Intelligence document.
void	setPublications(Publications publications) Sets the collection of publication IDs that use this document.
void	setRefreshOnOpen(boolean refreshOnOpen) Sets a boolean that indicates whether this document refreshes on open.
void	setRevisionNumber(int revisionNumber) Internal Use Only.
void	setSize(int size) Internal Use Only.
void	setSubject(java.lang.String subject) Sets the document subject.
void	setUniverses(Universes universes) Sets the IDs of the universes that are assigned to this Desktop Intelligence document.
void	setViewingShareHitDBOnRefresh(boolean viewingShareHitDBOnRefresh) A boolean indicating whether the viewer refresh hits the database.
void	setViewingShareInterval(int viewingShareInterval) Set the sharing interval.
void	setViewingShareReport(boolean viewingShareReport) Set whether report sharing will be used.
void	setViewingUseReportSharingSettings(boolean viewingUseReportSharingSettings) Set specific share settings for report viewing.
void	unsetAuthor() Deletes or unsets the Author element.
void	unsetCacheServerGroup() Deletes or unsets the CacheServerGroup element.
void	unsetCacheServerGroupChoice() Deletes or unsets the CacheServerGroupChoice element.
void	unsetComments() Deletes or unsets the Comments element.
void	unsetDocType() Internal Use Only.
void	unsetFullClientDataProviders() Deletes or unsets the FullClientDataProviders element.
void	unsetFullClientFormatOptions() Deletes or unsets the FullClientFormatOptions element.
void	unsetFullClientPrinterOptions() Deletes or unsets the FullClientPrinterOptions element.
void	unsetHasPrompts() Internal Use Only.
void	unsetHasVbaMacrosInside() Deletes or unsets the HasVbaMacrosInside element.
void	unsetLastActionDate() Internal Use Only.
void	unsetLastPrintDate() Internal Use Only.
void	unsetNbReports() Internal Use Only.
void	unsetPreCacheHTMLEnabled() Deletes or unsets the PreCacheHTMLEnabled element.
void	unsetPreCachePDFEnabled() Deletes or unsets the PreCachePDFEnabled element.
void	unsetPreCacheXLSEnabled() Deletes or unsets the PreCacheXLSEnabled element.
void	unsetProcessingServerGroup() Deletes or unsets the ProcessingServerGroup element.
void	unsetProcessingServerGroupChoice() Deletes or unsets the ProcessingServerGroupChoice element.
void	unsetPromptOnDemandViewing() Deletes or unsets the PromptOnDemandViewing element.
void	unsetPrompts() Deletes or unsets the Prompts element.
void	unsetPublications() Deletes or unsets the Publications element.
void	unsetRefreshOnOpen() Deletes or unsets the RefreshOnOpen element.
void	unsetRevisionNumber() Internal Use Only.
void	unsetSize() Internal Use Only.
void	unsetSubject() Deletes or unsets the Subject element.
void	unsetUniverses() Deletes or unsets the Universes element.
void	unsetViewingShareHitDBOnRefresh() Checks if the ViewingShareHitDBOnRefresh has been set.
void	unsetViewingShareInterval() Deletes or unsets the ViewingShareInterval element.
void	unsetViewingShareReport() Deletes or unsets the ViewingShareReport element.
void	unsetViewingUseReportSharingSettings() Deletes or unsets the ViewingUseReportSharingSettings element.
org.apache.xmlbeans.XmlString	xgetAuthor() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetCacheServerGroup() Internal Use Only.
ServerGroupChoiceEnum	xgetCacheServerGroupChoice() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetComments() Internal Use Only.
com.businessobjects.enterprise.fullclient.FullClientDocTypeEnum	xgetDocType() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetHasPrompts() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetHasVbaMacrosInside() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetLastActionDate() Internal Use Only.
org.apache.xmlbeans.XmlDateTime	xgetLastPrintDate() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetNbReports() 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.XmlString	xgetProcessingServerGroup() Internal Use Only.
ServerGroupChoiceEnum	xgetProcessingServerGroupChoice() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPromptOnDemandViewing() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetRefreshOnOpen() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetRevisionNumber() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetSize() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetSubject() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetViewingShareHitDBOnRefresh() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetViewingShareInterval() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetViewingShareReport() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetViewingUseReportSharingSettings() Internal Use Only.
void	xsetAuthor(org.apache.xmlbeans.XmlString author) Internal Use Only.
void	xsetCacheServerGroup(org.apache.xmlbeans.XmlString cacheServerGroup) Internal Use Only.
void	xsetCacheServerGroupChoice(ServerGroupChoiceEnum cacheServerGroupChoice) Internal Use Only.
void	xsetComments(org.apache.xmlbeans.XmlString comments) Internal Use Only.
void	xsetDocType(com.businessobjects.enterprise.fullclient.FullClientDocTypeEnum docType) Internal Use Only.
void	xsetHasPrompts(org.apache.xmlbeans.XmlBoolean hasPrompts) Internal Use Only.
void	xsetHasVbaMacrosInside(org.apache.xmlbeans.XmlBoolean hasVbaMacrosInside) Internal Use Only.
void	xsetLastActionDate(org.apache.xmlbeans.XmlDateTime lastActionDate) Internal Use Only.
void	xsetLastPrintDate(org.apache.xmlbeans.XmlDateTime lastPrintDate) Internal Use Only.
void	xsetNbReports(org.apache.xmlbeans.XmlInt nbReports) 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	xsetProcessingServerGroup(org.apache.xmlbeans.XmlString processingServerGroup) Internal Use Only.
void	xsetProcessingServerGroupChoice(ServerGroupChoiceEnum processingServerGroupChoice) Internal Use Only.
void	xsetPromptOnDemandViewing(org.apache.xmlbeans.XmlBoolean promptOnDemandViewing) Internal Use Only.
void	xsetRefreshOnOpen(org.apache.xmlbeans.XmlBoolean refreshOnOpen) Internal Use Only.
void	xsetRevisionNumber(org.apache.xmlbeans.XmlInt revisionNumber) Internal Use Only.
void	xsetSize(org.apache.xmlbeans.XmlInt size) Internal Use Only.
void	xsetSubject(org.apache.xmlbeans.XmlString subject) Internal Use Only.
void	xsetViewingShareHitDBOnRefresh(org.apache.xmlbeans.XmlBoolean viewingShareHitDBOnRefresh) Internal Use Only.
void	xsetViewingShareInterval(org.apache.xmlbeans.XmlInt viewingShareInterval) Internal Use Only.
void	xsetViewingShareReport(org.apache.xmlbeans.XmlBoolean viewingShareReport) Internal Use Only.
void	xsetViewingUseReportSharingSettings(org.apache.xmlbeans.XmlBoolean viewingUseReportSharingSettings) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getPublications

Publications getPublications()

Returns the collection of publication IDs that use this document.

Returns:

The collection of publication IDs that use this document.

isSetPublications

boolean isSetPublications()

Checks if the Publications has been set.

Returns:

true if the Publications element has been set, false.

setPublications

void setPublications(Publications publications)

Sets the collection of publication IDs that use this document.

Parameters:

publications - The collection of publication IDs that use this document.

addNewPublications

Publications addNewPublications()

Appends and returns a new empty Publications object to the last element of the array.

Returns:

A new Publications.

unsetPublications

void unsetPublications()

Deletes or unsets the Publications element.

getUniverses

Universes getUniverses()

Returns the IDs of the universes that are assigned to this Desktop Intelligence document.

Returns:

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

isSetUniverses

boolean isSetUniverses()

Checks if the Universes has been set.

Returns:

true if the Universes element has been set, false.

setUniverses

void setUniverses(Universes universes)

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

Parameters:

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

addNewUniverses

Universes addNewUniverses()

Appends and returns a new empty Publications object to the last element of the array.

Returns:

A new Publications.

unsetUniverses

void unsetUniverses()

Deletes or unsets the Universes element.

getNbReports

int getNbReports()

Internal Use Only.

xgetNbReports

org.apache.xmlbeans.XmlInt xgetNbReports()

Internal Use Only.

isSetNbReports

boolean isSetNbReports()

Internal Use Only.

setNbReports

void setNbReports(int nbReports)

Internal Use Only.

xsetNbReports

void xsetNbReports(org.apache.xmlbeans.XmlInt nbReports)

Internal Use Only.

unsetNbReports

void unsetNbReports()

Internal Use Only.

getComments

java.lang.String getComments()

Returns the document comments.

Returns:

A String that indicates the document comments.

xgetComments

org.apache.xmlbeans.XmlString xgetComments()

Internal Use Only.

isSetComments

boolean isSetComments()

Checks if the Comments has been set.

Returns:

true if the Comments element has been set, false.

setComments

void setComments(java.lang.String comments)

Sets the document comments.

Parameters:

comments - A String that indicates the document comments.

xsetComments

void xsetComments(org.apache.xmlbeans.XmlString comments)

Internal Use Only.

unsetComments

void unsetComments()

Deletes or unsets the Comments element.

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 PromptOnDemandViewing has been set.

Returns:

true if the PromptOnDemandViewing element has been set, false.

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.

getRefreshOnOpen

boolean getRefreshOnOpen()

Returns a boolean that indicates whether this document refreshes on open.

Returns:

true if this document refreshes on open, false otherwise.

xgetRefreshOnOpen

org.apache.xmlbeans.XmlBoolean xgetRefreshOnOpen()

Internal Use Only.

isSetRefreshOnOpen

boolean isSetRefreshOnOpen()

Checks if the RefreshOnOpen has been set.

Returns:

true if the RefreshOnOpen element has been set, false.

setRefreshOnOpen

void setRefreshOnOpen(boolean refreshOnOpen)

Sets a boolean that indicates whether this document refreshes on open.

Parameters:

refreshOnOpen - true if this document refreshes on open, false otherwise.

xsetRefreshOnOpen

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

Internal Use Only.

unsetRefreshOnOpen

void unsetRefreshOnOpen()

Deletes or unsets the RefreshOnOpen element.

getFullClientDataProviders

com.businessobjects.enterprise.fullclient.FullClientDataProviders getFullClientDataProviders()

Internal Use Only.

isSetFullClientDataProviders

boolean isSetFullClientDataProviders()

Checks if the FullClientDataProviders has been set.

Returns:

true if the FullClientDataProviders element has been set, false.

setFullClientDataProviders

void setFullClientDataProviders(com.businessobjects.enterprise.fullclient.FullClientDataProviders fullClientDataProviders)

Internal Use Only.

addNewFullClientDataProviders

com.businessobjects.enterprise.fullclient.FullClientDataProviders addNewFullClientDataProviders()

Appends and returns a new empty FullClientDataProviders object to the last element of the array.

Returns:

A new FullClientDataProviders.

unsetFullClientDataProviders

void unsetFullClientDataProviders()

Deletes or unsets the FullClientDataProviders element.

getPreCacheXLSEnabled

boolean getPreCacheXLSEnabled()

Returns a boolean that indicates whether the Microsoft excel format (XLS) that represents a Desktop 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 the PreCacheXLSEnabled element has been set.

Returns:

true if the PreCacheXLSEnabled element has been set, false.

setPreCacheXLSEnabled

void setPreCacheXLSEnabled(boolean preCacheXLSEnabled)

Sets a boolean that indicates whether the Microsoft excel format (XLS) that represents a Desktop 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.

getPreCachePDFEnabled

boolean getPreCachePDFEnabled()

Returns a boolean that indicates whether the Portable Document Format (PDF) that represents a Desktop 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 the PreCachePDFEnabled has been set.

Returns:

true if the PreCachePDFEnabled element has been set, false.

setPreCachePDFEnabled

void setPreCachePDFEnabled(boolean preCachePDFEnabled)

Sets a boolean that indicates whether the Portable Document Format (PDF) that represents a Desktop 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.

getPreCacheHTMLEnabled

boolean getPreCacheHTMLEnabled()

Returns a boolean that indicates whether the HTML text stream that represents a Desktop 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 the PreCacheHTMLEnabled has been set.

Returns:

true if the PreCacheHTMLEnabled element has been set, false.

setPreCacheHTMLEnabled

void setPreCacheHTMLEnabled(boolean preCacheHTMLEnabled)

Sets a boolean that indicates whether the HTML text stream that represents a Desktop 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.

getCacheServerGroupChoice

ServerGroupChoiceEnum.Enum getCacheServerGroupChoice()

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

Returns:

Specifies the server group.

xgetCacheServerGroupChoice

ServerGroupChoiceEnum xgetCacheServerGroupChoice()

Internal Use Only.

isSetCacheServerGroupChoice

boolean isSetCacheServerGroupChoice()

Checks if the CacheServerGroupChoice has been set.

Returns:

true if the CacheServerGroupChoice element has been set, false.

setCacheServerGroupChoice

void setCacheServerGroupChoice(ServerGroupChoiceEnum.Enum cacheServerGroupChoice)

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

Parameters:

cacheServerGroupChoice - Specifies the server group.

xsetCacheServerGroupChoice

void xsetCacheServerGroupChoice(ServerGroupChoiceEnum cacheServerGroupChoice)

Internal Use Only.

unsetCacheServerGroupChoice

void unsetCacheServerGroupChoice()

Deletes or unsets the CacheServerGroupChoice element.

getCacheServerGroup

java.lang.String getCacheServerGroup()

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

Returns:

The ID of the server group.

xgetCacheServerGroup

org.apache.xmlbeans.XmlString xgetCacheServerGroup()

Internal Use Only.

isSetCacheServerGroup

boolean isSetCacheServerGroup()

Checks if the CacheServerGroup has been set.

Returns:

true if the CacheServerGroup element has been set, false.

setCacheServerGroup

void setCacheServerGroup(java.lang.String cacheServerGroup)

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

Parameters:

cacheServerGroup - The ID of the server group.

xsetCacheServerGroup

void xsetCacheServerGroup(org.apache.xmlbeans.XmlString cacheServerGroup)

Internal Use Only.

unsetCacheServerGroup

void unsetCacheServerGroup()

Deletes or unsets the CacheServerGroup element.

getProcessingServerGroupChoice

ServerGroupChoiceEnum.Enum getProcessingServerGroupChoice()

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

Returns:

Specifies the server group.

xgetProcessingServerGroupChoice

ServerGroupChoiceEnum xgetProcessingServerGroupChoice()

Internal Use Only.

isSetProcessingServerGroupChoice

boolean isSetProcessingServerGroupChoice()

Checks if the ProcessingServerGroupChoice has been set.

Returns:

true if the ProcessingServerGroupChoice element has been set, false.

setProcessingServerGroupChoice

void setProcessingServerGroupChoice(ServerGroupChoiceEnum.Enum processingServerGroupChoice)

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

Parameters:

processingServerGroupChoice - Specifies the server group.

xsetProcessingServerGroupChoice

void xsetProcessingServerGroupChoice(ServerGroupChoiceEnum processingServerGroupChoice)

Internal Use Only.

unsetProcessingServerGroupChoice

void unsetProcessingServerGroupChoice()

Deletes or unsets the ProcessingServerGroupChoice element.

getProcessingServerGroup

java.lang.String getProcessingServerGroup()

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

Returns:

The ID of the server group.

xgetProcessingServerGroup

org.apache.xmlbeans.XmlString xgetProcessingServerGroup()

Internal Use Only.

isSetProcessingServerGroup

boolean isSetProcessingServerGroup()

Checks if the ProcessingServerGroup has been set.

Returns:

true if the ProcessingServerGroup element has been set, false.

setProcessingServerGroup

void setProcessingServerGroup(java.lang.String processingServerGroup)

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

Parameters:

processingServerGroup - The ID of the server group.

xsetProcessingServerGroup

void xsetProcessingServerGroup(org.apache.xmlbeans.XmlString processingServerGroup)

Internal Use Only.

unsetProcessingServerGroup

void unsetProcessingServerGroup()

Deletes or unsets the ProcessingServerGroup element.

getHasVbaMacrosInside

boolean getHasVbaMacrosInside()

Returns a boolean that indicates whether this document contains Visual Basic for Applications macros.

Returns:

true if this document contains Visual Basic for Applications macros, false otherwise.

xgetHasVbaMacrosInside

org.apache.xmlbeans.XmlBoolean xgetHasVbaMacrosInside()

Internal Use Only.

isSetHasVbaMacrosInside

boolean isSetHasVbaMacrosInside()

Checks if the HasVbaMacrosInside has been set.

Returns:

true if the HasVbaMacrosInside element has been set, false.

setHasVbaMacrosInside

void setHasVbaMacrosInside(boolean hasVbaMacrosInside)

Sets a boolean that indicates whether this document contains Visual Basic for Applications macros.

Parameters:

hasVbaMacrosInside - true if this document contains Visual Basic for Applications macros, false otherwise.

xsetHasVbaMacrosInside

void xsetHasVbaMacrosInside(org.apache.xmlbeans.XmlBoolean hasVbaMacrosInside)

Internal Use Only.

unsetHasVbaMacrosInside

void unsetHasVbaMacrosInside()

Deletes or unsets the HasVbaMacrosInside element.

getLastPrintDate

java.util.Calendar getLastPrintDate()

Internal Use Only.

xgetLastPrintDate

org.apache.xmlbeans.XmlDateTime xgetLastPrintDate()

Internal Use Only.

isSetLastPrintDate

boolean isSetLastPrintDate()

Internal Use Only.

setLastPrintDate

void setLastPrintDate(java.util.Calendar lastPrintDate)

Internal Use Only.

xsetLastPrintDate

void xsetLastPrintDate(org.apache.xmlbeans.XmlDateTime lastPrintDate)

Internal Use Only.

unsetLastPrintDate

void unsetLastPrintDate()

Internal Use Only.

getLastActionDate

java.util.Calendar getLastActionDate()

Internal Use Only.

xgetLastActionDate

org.apache.xmlbeans.XmlDateTime xgetLastActionDate()

Internal Use Only.

isSetLastActionDate

boolean isSetLastActionDate()

Internal Use Only.

setLastActionDate

void setLastActionDate(java.util.Calendar lastActionDate)

Internal Use Only.

xsetLastActionDate

void xsetLastActionDate(org.apache.xmlbeans.XmlDateTime lastActionDate)

Internal Use Only.

unsetLastActionDate

void unsetLastActionDate()

Internal Use Only.

getSize

int getSize()

Internal Use Only.

xgetSize

org.apache.xmlbeans.XmlInt xgetSize()

Internal Use Only.

isSetSize

boolean isSetSize()

Internal Use Only.

setSize

void setSize(int size)

Internal Use Only.

xsetSize

void xsetSize(org.apache.xmlbeans.XmlInt size)

Internal Use Only.

unsetSize

void unsetSize()

Internal Use Only.

getHasPrompts

boolean getHasPrompts()

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

Returns:

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

xgetHasPrompts

org.apache.xmlbeans.XmlBoolean xgetHasPrompts()

Internal Use Only.

isSetHasPrompts

boolean isSetHasPrompts()

Checks if the HasPrompts has been set.

Returns:

true if the HasPrompts element has been set, false.

setHasPrompts

void setHasPrompts(boolean hasPrompts)

Internal Use Only.

xsetHasPrompts

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

Internal Use Only.

unsetHasPrompts

void unsetHasPrompts()

Internal Use Only.

getAuthor

java.lang.String getAuthor()

Returns the document owner.

Returns:

A String that indicates the document owner.

xgetAuthor

org.apache.xmlbeans.XmlString xgetAuthor()

Internal Use Only.

isSetAuthor

boolean isSetAuthor()

Checks if the Author has been set.

Returns:

true if the Author element has been set, false.

setAuthor

void setAuthor(java.lang.String author)

Sets the document owner.

Parameters:

author - A String that indicates the document owner.

xsetAuthor

void xsetAuthor(org.apache.xmlbeans.XmlString author)

Internal Use Only.

unsetAuthor

void unsetAuthor()

Deletes or unsets the Author element.

getRevisionNumber

int getRevisionNumber()

Internal Use Only.

xgetRevisionNumber

org.apache.xmlbeans.XmlInt xgetRevisionNumber()

Internal Use Only.

isSetRevisionNumber

boolean isSetRevisionNumber()

Internal Use Only.

setRevisionNumber

void setRevisionNumber(int revisionNumber)

Internal Use Only.

xsetRevisionNumber

void xsetRevisionNumber(org.apache.xmlbeans.XmlInt revisionNumber)

Internal Use Only.

unsetRevisionNumber

void unsetRevisionNumber()

Internal Use Only.

getDocType

com.businessobjects.enterprise.fullclient.FullClientDocTypeEnum.Enum getDocType()

Internal Use Only.

xgetDocType

com.businessobjects.enterprise.fullclient.FullClientDocTypeEnum xgetDocType()

Internal Use Only.

isSetDocType

boolean isSetDocType()

Internal Use Only.

setDocType

void setDocType(com.businessobjects.enterprise.fullclient.FullClientDocTypeEnum.Enum docType)

Internal Use Only.

xsetDocType

void xsetDocType(com.businessobjects.enterprise.fullclient.FullClientDocTypeEnum docType)

Internal Use Only.

unsetDocType

void unsetDocType()

Internal Use Only.

getSubject

java.lang.String getSubject()

Returns the document subject.

Returns:

A String that indicates the document subject.

xgetSubject

org.apache.xmlbeans.XmlString xgetSubject()

Internal Use Only.

isSetSubject

boolean isSetSubject()

Checks if the Subject element has been set.

Returns:

true if the Subject element has been set, false.

setSubject

void setSubject(java.lang.String subject)

Sets the document subject.

Parameters:

subject - A String that indicates the document subject.

xsetSubject

void xsetSubject(org.apache.xmlbeans.XmlString subject)

Internal Use Only.

unsetSubject

void unsetSubject()

Deletes or unsets the Subject element.

getFullClientPrinterOptions

FullClientPrinterOptions getFullClientPrinterOptions()

Returns the printer options associated with this Desktop Intelligence document.

Returns:

The printer options.

isSetFullClientPrinterOptions

boolean isSetFullClientPrinterOptions()

Checks if the FullClientPrinterOptions has been set.

Returns:

true if the FullClientPrinterOptions element has been set, false.

setFullClientPrinterOptions

void setFullClientPrinterOptions(FullClientPrinterOptions fullClientPrinterOptions)

Sets the printer options associated with this Desktop Intelligence document.

Parameters:

fullClientPrinterOptions - The printer options.

addNewFullClientPrinterOptions

FullClientPrinterOptions addNewFullClientPrinterOptions()

Appends and returns a new empty FullClientPrinterOptions object to the last element of the array.

Returns:

A new FullClientPrinterOptions.

unsetFullClientPrinterOptions

void unsetFullClientPrinterOptions()

Deletes or unsets the FullClientPrinterOptions element.

getPrompts

FullClientPrompts getPrompts()

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

Returns:

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

isSetPrompts

boolean isSetPrompts()

Checks if the Prompts has been set.

Returns:

true if the Prompts element has been set, false.

setPrompts

void setPrompts(FullClientPrompts prompts)

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

Parameters:

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

addNewPrompts

FullClientPrompts addNewPrompts()

Appends and returns a new empty FullClientPrompts object to the last element of the array.

Returns:

A new FullClientPrompts.

unsetPrompts

void unsetPrompts()

Deletes or unsets the Prompts element.

getFullClientFormatOptions

FullClientFormatOptions getFullClientFormatOptions()

Returns the export format options.

Returns:

The export format options.

isSetFullClientFormatOptions

boolean isSetFullClientFormatOptions()

Checks if the FullClientFormatOptions has been set.

Returns:

true if the FullClientFormatOptions element has been set, false.

setFullClientFormatOptions

void setFullClientFormatOptions(FullClientFormatOptions fullClientFormatOptions)

Sets the export format options.

Parameters:

fullClientFormatOptions - The export format options.

addNewFullClientFormatOptions

FullClientFormatOptions addNewFullClientFormatOptions()

Appends and returns a new empty FullClientFormatOptions object to the last element of the array.

Returns:

A new FullClientFormatOptions.

unsetFullClientFormatOptions

void unsetFullClientFormatOptions()

Deletes or unsets the FullClientFormatOptions element.

getViewingUseReportSharingSettings

boolean getViewingUseReportSharingSettings()

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

Returns:

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

xgetViewingUseReportSharingSettings

org.apache.xmlbeans.XmlBoolean xgetViewingUseReportSharingSettings()

Internal Use Only.

isSetViewingUseReportSharingSettings

boolean isSetViewingUseReportSharingSettings()

Checks if the ViewingUseReportSharingSettings element has been set.

Returns:

true if the ViewingUseReportSharingSettings element has been set, false.

setViewingUseReportSharingSettings

void setViewingUseReportSharingSettings(boolean viewingUseReportSharingSettings)

Set specific share settings for report viewing.

Parameters:

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

xsetViewingUseReportSharingSettings

void xsetViewingUseReportSharingSettings(org.apache.xmlbeans.XmlBoolean viewingUseReportSharingSettings)

Internal Use Only.

unsetViewingUseReportSharingSettings

void unsetViewingUseReportSharingSettings()

Deletes or unsets the ViewingUseReportSharingSettings element.

getViewingShareReport

boolean getViewingShareReport()

Returns a boolean indicating whether report sharing is being used.

Returns:

A boolean indicating whether report sharing is being used.

xgetViewingShareReport

org.apache.xmlbeans.XmlBoolean xgetViewingShareReport()

Internal Use Only.

isSetViewingShareReport

boolean isSetViewingShareReport()

Checks if the ViewingShareReport has been set.

Returns:

true if the ViewingShareReport element has been set, false.

setViewingShareReport

void setViewingShareReport(boolean viewingShareReport)

Set whether report sharing will be used.

Parameters:

viewingShareReport - A boolean indicating whether report sharing is being used.

xsetViewingShareReport

void xsetViewingShareReport(org.apache.xmlbeans.XmlBoolean viewingShareReport)

Internal Use Only.

unsetViewingShareReport

void unsetViewingShareReport()

Deletes or unsets the ViewingShareReport element.

getViewingShareInterval

int getViewingShareInterval()

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

Returns:

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

xgetViewingShareInterval

org.apache.xmlbeans.XmlInt xgetViewingShareInterval()

Internal Use Only.

isSetViewingShareInterval

boolean isSetViewingShareInterval()

Checks if the ViewingShareInterval element has been set.

Returns:

true if the ViewingShareInterval element has been set, false.

setViewingShareInterval

void setViewingShareInterval(int viewingShareInterval)

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

Parameters:

viewingShareInterval - An Integer indicating the time (in seconds) that the report data will be shared.

xsetViewingShareInterval

void xsetViewingShareInterval(org.apache.xmlbeans.XmlInt viewingShareInterval)

Internal Use Only.

unsetViewingShareInterval

void unsetViewingShareInterval()

Deletes or unsets the ViewingShareInterval element.

getViewingShareHitDBOnRefresh

boolean getViewingShareHitDBOnRefresh()

A boolean indicating whether the viewer refresh hits the database.

Returns:

A boolean indicating whether the viewer refresh hits the database.

xgetViewingShareHitDBOnRefresh

org.apache.xmlbeans.XmlBoolean xgetViewingShareHitDBOnRefresh()

Internal Use Only.

isSetViewingShareHitDBOnRefresh

boolean isSetViewingShareHitDBOnRefresh()

Checks if the ViewingShareHitDBOnRefresh has been set.

Returns:

true if the ViewingShareHitDBOnRefresh element has been set, false.

setViewingShareHitDBOnRefresh

void setViewingShareHitDBOnRefresh(boolean viewingShareHitDBOnRefresh)

A boolean indicating whether the viewer refresh hits the database.

Parameters:

viewingShareHitDBOnRefresh - A boolean indicating whether the viewer refresh hits the database.

xsetViewingShareHitDBOnRefresh

void xsetViewingShareHitDBOnRefresh(org.apache.xmlbeans.XmlBoolean viewingShareHitDBOnRefresh)

Internal Use Only.

unsetViewingShareHitDBOnRefresh

void unsetViewingShareHitDBOnRefresh()

Checks if the ViewingShareHitDBOnRefresh has been set.