com.crystaldecisions.sdk.plugin.desktop.report
Interface IReportBase

All Superinterfaces:
IReportProcessingInfo, IViewingServerGroupInfo
All Known Subinterfaces:
IReport

public interface IReportBase
extends IReportProcessingInfo

This interface enables getting and setting basic information about the report.


Method Summary
 Set getBusinessViews()
          Gets a collection of Business View IDs that have been assigned to this report.
 IReportHyperlinkResolves getHyperlinkResolves()
           Gets a IReportHyperlinkResolves collection.
 java.lang.String getReportFileName()
          Gets the ReportFileName.
 IReportRefreshOptions getReportRefreshOptions()
          Get the report refresh options.
 boolean isKeepSavedData()
          Gets a boolean that indicates whether saved data will be kept in this object when the report is added.
 boolean isRepositoryEnabled()
          Gets a boolean that indicates whether this object needs access to a repository data source.
 boolean isThumbnailEnabled()
          Gets the value for SI_TURNONTHUMBNAIL.
 boolean isUseOldPromptStyle()
           Gets a boolean that indicates whether the report uses the old prompt style.
 void refreshProperties()
          Refreshes the properties from the report according to the options.
 void setKeepSavedData(boolean keep)
           Sets a boolean that indicates whether saved date will be kept in this object when the report is added.
 void setRepositoryEnabled(boolean enabled)
          Sets a boolean that indicates whether this object needs access to a repository data source.
 void setThumbnailEnabled(boolean bEnable)
          Sets the value for SI_TURNONTHUMBNAIL.
 void setUseOldPromptStyle(boolean useOldStyle)
           Sets a boolean that indicates whether the report uses the old prompt style.
 
Methods inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IReportProcessingInfo
getGroupFormula, getProcessingSecurityExtensions, getPromptGroupMembers, getRecordFormula, getReportAlerts, getReportFormatOptions, getReportHyperlinks, getReportLogons, getReportParameters, getReportPrinterOptions, getViewingShareInterval, hasDynamicCascadePrompt, isLogonNeeded, isViewingShareHitDBOnRefresh, isViewingShareReport, isViewingUseReportSharingSettings, queryRepositoryOptions, setGroupFormula, setLogonNeeded, setRecordFormula, setViewingShareHitDBOnRefresh, setViewingShareInterval, setViewingShareReport, setViewingUseReportSharingSettings
 
Methods inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IViewingServerGroupInfo
getViewingServerGroup, getViewingServerGroupChoice, setViewingServerGroup, setViewingServerGroupChoice
 

Method Detail

getReportFileName

public java.lang.String getReportFileName()
                                   throws SDKException

Gets the ReportFileName.

Returns:
A String containing the report file name value.
Throws:
SDKException

isThumbnailEnabled

public boolean isThumbnailEnabled()
                           throws SDKException

Gets the value for SI_TURNONTHUMBNAIL. A thumbnail will only be displayed if it was generated when the report was created.

Returns:
true if thumbnail is enabled for this object.
Throws:
SDKException

setThumbnailEnabled

public void setThumbnailEnabled(boolean bEnable)

Sets the value for SI_TURNONTHUMBNAIL. A thumbnail will only be displayed if it was generated when the report was created.

Parameters:
bEnable - true to enable the thumbnail for this object, false otherwise.

isRepositoryEnabled

public boolean isRepositoryEnabled()

Gets a boolean that indicates whether this object needs access to a repository data source.

Specified by:
isRepositoryEnabled in interface IReportProcessingInfo
Returns:
true if this object needs access to a repository data source, and false otherwise.

setRepositoryEnabled

public void setRepositoryEnabled(boolean enabled)

Sets a boolean that indicates whether this object needs access to a repository data source.

Specified by:
setRepositoryEnabled in interface IReportProcessingInfo
Parameters:
enabled - true if this object needs access to a repository data source.

refreshProperties

public void refreshProperties()
                       throws SDKException

Refreshes the properties from the report according to the options.

Throws:
SDKException - This is thrown if the process is unsuccessful.

getReportRefreshOptions

public IReportRefreshOptions getReportRefreshOptions()
                                              throws SDKException

Get the report refresh options. The options will be used when refreshing the properties from the report.

Returns:
Refresh options for this report plugin
Throws:
SDKException - This is thrown if the process is unsuccessful.

getHyperlinkResolves

public IReportHyperlinkResolves getHyperlinkResolves()
                                              throws SDKException

Gets a IReportHyperlinkResolves collection.

Returns:
A IReportHyperlinkResolves collection.
Throws:
SDKException - This is thrown if the process is unsuccessful.

isKeepSavedData

public boolean isKeepSavedData()
                        throws SDKException

Gets a boolean that indicates whether saved data will be kept in this object when the report is added.

Returns:
true if this object will keep the saved data in the report file, and false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setKeepSavedData

public void setKeepSavedData(boolean keep)
                      throws SDKException

Sets a boolean that indicates whether saved date will be kept in this object when the report is added.

Parameters:
keep - true if this object preserves the saved data in the report file.
SDKException

getBusinessViews

public Set getBusinessViews()
                     throws SDKException

Gets a collection of Business View IDs that have been assigned to this report.

Returns:
A Set that contains Business View IDs that have been assigned to this report.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setUseOldPromptStyle

public void setUseOldPromptStyle(boolean useOldStyle)
                          throws SDKException

Sets a boolean that indicates whether the report uses the old prompt style.

Parameters:
useOldStyle - A boolean that indicates whether the report uses the old prompt style.
Throws:
SDKException - This is thrown if the process is unsuccessful.

isUseOldPromptStyle

public boolean isUseOldPromptStyle()
                            throws SDKException

Gets a boolean that indicates whether the report uses the old prompt style.

Returns:
true if the report uses the old prompt style, and false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.