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

All Superinterfaces:

ICacheServerGroupInfo, IFullClientProcessingInfo, IProcessingPublicationInfo, IProcessingServerGroupInfo

All Known Subinterfaces:

IFullClient

public interface IFullClientBase
extends IFullClientProcessingInfo

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

Method Summary

java.lang.String	getAuthor()
java.lang.String	getComments() Returns the document comments.
int	getDocType() Returns the document type.
IFullClientDataProviders	getFullClientDataProviders() Returns the collection of data providers associated with this document.
IFullClientFormatOptions	getFullClientFormatOptions() Returns the export format options.
java.util.Date	getLastActionDate() Returns the last action date.
java.util.Date	getLastPrintDate() Returns the last print date.
int	getNbReports() Returns the number of reports in the document.
java.lang.String	getOwner() Returns the document owner.
boolean	getRefreshOnOpen() Returns a boolean that indicates whether this document refreshes on open.
int	getRevisionNumber() Returns the revision number.
int	getSize() Returns the document size in bytes.
java.lang.String	getSubject() Returns the document subject.
java.util.Set	getUniverses() Returns the IDs of the universes that are assigned to this Desktop Intelligence document.
boolean	hasVbaMacrosInside() Returns a boolean that indicates whether this document contains Visual Basic for Applications macros.
boolean	isPreCacheHTMLEnabled() Returns a boolean that indicates whether the HTML text stream that represents a Desktop 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 Desktop 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 Desktop Intelligence document will be pre-loaded into the cache.
void	setAuthor(java.lang.String val)
void	setComments(java.lang.String val) Sets the document comments.
void	setDocType(int newVal) Sets the document type.
void	setLastActionDate(java.util.Date d) Sets the last action date.
void	setLastPrintDate(java.util.Date d) Sets the last print date.
void	setNbReports(int val) Sets the number of reports in the document.
void	setOwner(java.lang.String val) Sets the document owner.
void	setPreCacheHTMLEnabled(boolean bEnable) 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 bEnable) 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 bEnable) 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	setRefreshOnOpen(boolean val) Sets a boolean that indicates whether this document refreshes on open.
void	setRevisionNumber(int val) Sets the revision number.
void	setSize(int newVal) Sets the document size in bytes.
void	setSubject(java.lang.String val) Sets the document subject.
void	setVbaMacrosInside(boolean val) Sets a boolean that indicates whether this document contains Visual Basic for Applications macros.

Methods inherited from interface com.businessobjects.sdk.plugin.desktop.fullclient.IFullClientProcessingInfo

getFullClientPrinterOptions, getPrompts, getViewingShareInterval, hasPrompts, isPromptOnDemandViewing, isViewingShareHitDBOnRefresh, isViewingShareReport, isViewingUseReportSharingSettings, setPromptOnDemandViewing, setViewingShareHitDBOnRefresh, setViewingShareInterval, setViewingShareReport, setViewingUseReportSharingSettings

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

getUniverses

java.util.Set getUniverses()
                           throws SDKException

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

Returns:

Set of IDs corresponding to the Universes that belong to the current document.

Throws:

SDKException - Throws exception if property is not found

See Also:

IUniverseBase

isPreCacheHTMLEnabled

boolean isPreCacheHTMLEnabled()
                              throws SDKException

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.

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 Desktop Intelligence document will be pre-loaded into the cache.

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

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 Desktop Intelligence document will be pre-loaded into the cache.

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPreCacheXLSEnabled

void setPreCacheXLSEnabled(boolean bEnable)
                           throws SDKException

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:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFullClientFormatOptions

IFullClientFormatOptions getFullClientFormatOptions()
                                                    throws SDKException

Returns the export format options.

Returns:

The export format options.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDocType

int getDocType()
               throws SDKException

Returns the document type.

Returns:

An int that indicates the document type.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDocType

void setDocType(int newVal)
                throws SDKException

Sets the document type.

Parameters:

newVal - An int that indicates the document type.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getSize

int getSize()
            throws SDKException

Returns the document size in bytes.

Returns:

An int that indicates the document size in bytes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSize

void setSize(int newVal)
             throws SDKException

Sets the document size in bytes.

Parameters:

newVal - An int that indicates the document size in bytes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getComments

java.lang.String getComments()
                             throws SDKException

Returns the document comments.

Returns:

A String that indicates the document comments.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setComments

void setComments(java.lang.String val)
                 throws SDKException

Sets the document comments.

Parameters:

val - A String that indicates the document comments.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getOwner

java.lang.String getOwner()
                          throws SDKException

Returns the document owner.

Returns:

A String that indicates the document owner.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setOwner

void setOwner(java.lang.String val)
              throws SDKException

Sets the document owner.

Parameters:

val - A String that indicates the document owner.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getAuthor

java.lang.String getAuthor()
                           throws SDKException

Throws:

SDKException

setAuthor

void setAuthor(java.lang.String val)
               throws SDKException

Throws:

SDKException

getSubject

java.lang.String getSubject()
                            throws SDKException

Returns the document subject.

Returns:

A String that indicates the document subject.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSubject

void setSubject(java.lang.String val)
                throws SDKException

Sets the document subject.

Parameters:

val - A String that indicates the document subject.

Throws:

SDKException - This is thrown if the process is unsuccessful.

hasVbaMacrosInside

boolean hasVbaMacrosInside()
                           throws SDKException

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.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setVbaMacrosInside

void setVbaMacrosInside(boolean val)
                        throws SDKException

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

Parameters:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

getRefreshOnOpen

boolean getRefreshOnOpen()
                         throws SDKException

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

Returns:

true if this document refreshes on open, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setRefreshOnOpen

void setRefreshOnOpen(boolean val)
                      throws SDKException

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

Parameters:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

getRevisionNumber

int getRevisionNumber()
                      throws SDKException

Returns the revision number.

Returns:

An int that indicates the revision number.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setRevisionNumber

void setRevisionNumber(int val)
                       throws SDKException

Sets the revision number.

Parameters:

val - An int that indicates the revision number.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getNbReports

int getNbReports()
                 throws SDKException

Returns the number of reports in the document.

Returns:

An int that indicates the number of reports in the document.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setNbReports

void setNbReports(int val)
                  throws SDKException

Sets the number of reports in the document.

Parameters:

val - An int that indicates the number of reports in the document.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getLastPrintDate

java.util.Date getLastPrintDate()
                                throws SDKException

Returns the last print date.

Returns:

The last print date.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setLastPrintDate

void setLastPrintDate(java.util.Date d)
                      throws SDKException

Sets the last print date.

Parameters:

d - The last print date.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getLastActionDate

java.util.Date getLastActionDate()
                                 throws SDKException

Returns the last action date.

Returns:

The last action date.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setLastActionDate

void setLastActionDate(java.util.Date d)
                       throws SDKException

Sets the last action date.

Parameters:

d - The last action date.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFullClientDataProviders

IFullClientDataProviders getFullClientDataProviders()
                                                    throws SDKException

Returns the collection of data providers associated with this document.

Returns:

The collection of data providers associated with this document.

Throws:

SDKException - This is thrown if the process is unsuccessful.