com.crystaldecisions.sdk.occa.report.document
Interface IReportOptions

All Superinterfaces:
IClone
All Known Implementing Classes:
ReportOptions

public interface IReportOptions
extends IClone

This interface enables you to get and set a number of technical options that apply only to an active report. The settings for these options are saved with the report and do not affect any other reports. To access these settings in the Report Designer from the Report Options dialog box, click File > Report Options. Setting report options can be useful when working with reports for distribution.

To modify report options use the ReportClientDocument.modifyReportOptions method.

Example:

This sample shows how to set the Verify on First Refresh option in a report. Note: This sample code assumes you already have a ReportClientDocument object that represents an opened report.

 IReportDocument reportDocument = clientDoc.getReportDocument();
 ReportOptions reportOptions = new ReportOptions(reportDocument.getReportOptions());
 reportOptions.setEnableVerifyOnEveryPrint(true);
 clientDoc.modifyReportOptions(reportOptions);
 


Method Summary
 boolean getCanSelectDistinctRecords()
          Returns whether the report's data source supports the selection of unique records (Select Distinct) from SQL tables.
 boolean getCanSetTableLocation()
          For internal use only.
 ConvertDateTimeType getConvertDateTimeType()
          For internal use only.
 boolean getConvertDBNullToDefault()
           
 boolean getConvertOtherNullToDefault()
           
 boolean getCreateGroupTree()
           Returns if create group tree
 boolean getEnableAsyncQuery()
          Returns whether the program uses asynchronous queries.
 boolean getEnablePushDownGroupBy()
           Returns whether the program performs grouping on the server (server-side processing).
 boolean getEnableSaveDataWithReport()
          Returns whether the report definition and the underlying data are saved with the report.
 boolean getEnableSaveSummariesWithReport()
          For internal use only.
 boolean getEnableSelectDistinctRecords()
          Returns whether in the report only unique records are being selected from the SQL tables in your database.
 boolean getEnableTranslateDOSMemos()
          For internal use only.
 boolean getEnableTranslateDOSStrings()
          For internal use only.
 boolean getEnableUseCaseInsensitiveSQLData()
          For internal use only.
 boolean getEnableUseDummyData()
          For internal use only.
 boolean getEnableUseIndexForSpeed()
          For internal use only.
 boolean getEnableVerifyOnEveryPrint()
           Returns whether the report refreshes with the current version of the active database (unless it is a stored procedure) and resets its record buffers to the current record size the first time you refresh it per session.
 boolean getErrorOnMaxNumOfRecords()
          Returns true if an error message is displayed and the report fails when the maximum number of records is reached.
 java.lang.String getInitialDataContext()
          Returns the initial data context with which the report is displayed.
 java.lang.String getInitialReportPartName()
          Returns the initial report part name for the report part that is displayed.
 int getMaxNumOfRecords()
          Returns the maximum number of records the program can use in a report.
 int getNumOfBrowsingRecords()
           Returns the number of records that are retrieved when using the various browse methods in the com.crystaldecisions.sdk.occa.report.application.RowsetController class to examine the contents of the report's database.
 int getNumOfCachedBatches()
          Returns the default number of rowset batches that are cached in the RowsetCursor.
 boolean getRefreshCEProperties()
           Queries the report to see if the object's settings are updated when saved to BusinessObjects Enterprise.
 ReportStyle getReportStyle()
          For internal use only.
 boolean getRespectKeepGroupTogetherOnFirstPage()
           Returns if respect keep group together on first page
 int getRowsetBatchSize()
           Returns the number of records in each batch in the rowset.
 boolean getShowAllHeadersOnDrillDown()
           
 boolean getSuppressPrintingIfNoRecords()
           Returns if suppress printing when no records
 boolean getVerifyStoredProcOnFirstRefresh()
           Returns if refresh stored procedure on first refresh
 ZoomMode getZoomMode()
           returns the current zoom mode
 void setCanSelectDistinctRecords(boolean canSelectDistinctRecords)
          Sets whether the report's data source supports the selection of unique records (Select Distinct) from SQL tables.
 void setCanSetTableLocation(boolean canSetTableLocation)
          For internal use only.
 void setConvertDateTimeType(ConvertDateTimeType convertDateTimeType)
          For internal use only.
 void setConvertDBNullToDefault(boolean bConvertDBNullToDefault)
           
 void setConvertOtherNullToDefault(boolean bConvertOtherNullToDefault)
           
 void setCreateGroupTree(boolean bCreateGroupTree)
           set value if create group tree
 void setEnableAsyncQuery(boolean enableAsyncQuery)
          Sets whether the program uses asynchronous queries.
 void setEnablePushDownGroupBy(boolean enablePushDownGroupBy)
           Sets whether the program performs grouping on the server (server-side processing).
 void setEnableSaveDataWithReport(boolean enableSaveDataWithReport)
          Sets whether the report definition and the underlying data are saved with the report.
 void setEnableSaveSummariesWithReport(boolean enableSaveSummariesWithReport)
          For internal use only.
 void setEnableSelectDistinctRecords(boolean enableSelectDistinctRecords)
          Sets whether in the report only unique records are being selected from the SQL tables in your database.
 void setEnableTranslateDOSMemos(boolean enableTranlateDOSMemos)
          For internal use only.
 void setEnableTranslateDOSStrings(boolean enableTranslateDOSStrings)
          For internal use only.
 void setEnableUseCaseInsensitiveSQLData(boolean enableUseCaseInsensitiveSQLData)
          For internal use only.
 void setEnableUseDummyData(boolean enableUseDummyData)
          For internal use only.
 void setEnableUseIndexForSpeed(boolean enableUseIndexForSpeed)
          For internal use only.
 void setEnableVerifyOnEveryPrint(boolean enableVerifyOnEveryPrint)
           Sets whether the report refreshes with the current version of the active database (unless it is a stored procedure) and resets its record buffers to the current record size the first time you refresh it per session.
 void setErrorOnMaxNumOfRecords(boolean errorOnMaxNumOfRecords)
           Sets the value of errorOnMaxNumOfRecords to true if an error message is displayed and the report fails when the maximum number of records is reached.
 void setInitialDataContext(java.lang.String newVal)
          Sets the initial data context with which the report is displayed.
 void setInitialReportPartName(java.lang.String newVal)
          Sets the initial report part name for the report part that is displayed.
 void setMaxNumOfRecords(int maxNumOfRecords)
          Sets the maximum number of records the program can use in a report.
 void setNumOfBrowsingRecords(int newNumOfBrowsingRecords)
           Sets the number of records that are retrieved when using the various browse methods in the com.crystaldecisions.sdk.occa.report.application.RowsetController class to examine the contents of the report's database.
 void setNumOfCachedBatches(int newNumOfCachedBatches)
          Sets the default number of rowset batches that are cached in the RowsetCursor.
 void setRefreshCEProperties(boolean refreshCEProperties)
           Sets the value of refreshCEProperties to true if the object's settings are updated when saved to BusinessObjects Enterprise and to false.
 void setReportStyle(ReportStyle newReportStyle)
          Deprecated. 
 void setRespectKeepGroupTogetherOnFirstPage(boolean bRespectKeepGroupTogetherOnFirstPage)
           set value if respect keep group together on first page
 void setRowsetBatchSize(int newRowsetBatchSize)
           Sets the number of records in each batch in the rowset.
 void setShowAllHeadersOnDrillDown(boolean bShowAllHeadersOnDrillDown)
           
 void setSuppressPrintingIfNoRecords(boolean bSuppressPrintingIfNoRecords)
           set value if suppress printing when no records
 void setVerifyStoredProcOnFirstRefresh(boolean bVerifyStoredProcOnFirstRefresh)
           set value if refresh stored procedure on first refresh
 void setZoomMode(ZoomMode zoomMode)
           set current zoom mode
 

Method Detail

getCanSelectDistinctRecords

boolean getCanSelectDistinctRecords()

Returns whether the report's data source supports the selection of unique records (Select Distinct) from SQL tables. If this property is set to true, then the report can use the Select Distinct option, unless setEnableSelectDistinctRecords is set to false. However, if this property is set to false, then the report does not support the Select Distinct option.

Returns:
true if the report's data source supports the selection of unique records (Select Distinct) from SQL tables, and false otherwise.

getCanSetTableLocation

boolean getCanSetTableLocation()

For internal use only.


getConvertDateTimeType

ConvertDateTimeType getConvertDateTimeType()

For internal use only.


getEnableAsyncQuery

boolean getEnableAsyncQuery()

Returns whether the program uses asynchronous queries. The program normally sends an entire query to the database server. Setting this property to true, however, allows the program and the ODBC database server (if it supports asynchronous queries) to transfer data back and forth. An advantage of using this report option is you can cancel queries during processing more easily.

Note: This method returns the value of the Perform Query Asynchronously check box in the Report Options dialog box of the Report Designer.

Returns:
true if the program uses asynchronous queries, and false otherwise.

getEnablePushDownGroupBy

boolean getEnablePushDownGroupBy()

Returns whether the program performs grouping on the server (server-side processing). Server-side processing allows you to set up a report that performs the majority of its processing on the server and pushes only relevant details to the client computer. Server-side processing provides you with a number of benefits:

The one disadvantage of server-side processing is that the report submits an SQL query for each group node (Totaller node).

Note: This method returns the value of the Perform Grouping On Server check box in the Report Options dialog box of the Report Designer.

Returns:
true if the program performs grouping on the server (server-side processing), and false otherwise.

getEnableSaveDataWithReport

boolean getEnableSaveDataWithReport()

Returns whether the report definition and the underlying data are saved with the report. When this property is set to true, then when the report is opened again, it will include the data that was available the last time it was saved. When this property is set to false, the data will refresh each time the report is opened.

If you save the data with the report, your report will require more disk space, but the program will not need to retrieve the data again before it prints the report.

Note: This method returns the value of the Save Data With Report check box in the Report Options dialog box of the Report Designer.

Returns:
true if the current data is saved with the report, and false otherwise.

getEnableSaveSummariesWithReport

boolean getEnableSaveSummariesWithReport()

For internal use only.


getEnableSelectDistinctRecords

boolean getEnableSelectDistinctRecords()

Returns whether in the report only unique records are being selected from the SQL tables in your database. If the getCanSelectDistinctRecords() method returns false, then the data source does not support the Select Distinct feature which also means that the report does not support Select Distinct. If the getCanSelectDistinctRecords() method returns true, then you have the option of enabling or disabling the Select Distinct feature for each report.

Note: This method returns the value of the Select Distinct Records check box in the Report Options dialog box of the Report Designer.

Returns:
true if, in the report, only unique records are being selected from the SQL tables in your database, and false otherwise.

getEnableTranslateDOSStrings

boolean getEnableTranslateDOSStrings()

For internal use only.


getEnableUseCaseInsensitiveSQLData

boolean getEnableUseCaseInsensitiveSQLData()

For internal use only.


getEnableUseDummyData

boolean getEnableUseDummyData()

For internal use only.


getEnableUseIndexForSpeed

boolean getEnableUseIndexForSpeed()

For internal use only.


getEnableVerifyOnEveryPrint

boolean getEnableVerifyOnEveryPrint()

Returns whether the report refreshes with the current version of the active database (unless it is a stored procedure) and resets its record buffers to the current record size the first time you refresh it per session.

Note: This method returns the value of the Verify on First Refresh check box in the Report Options dialog box of the Report Designer.

Returns:
true if the active database is verified when the report is first refreshed in a session, and false otherwise.

getInitialDataContext

java.lang.String getInitialDataContext()

Returns the initial data context with which the report is displayed. For example, a report based on data that is grouped by country might have an initial data context of England if the report was designed to display information for this country when opened.

Note: This method returns the value of the Data Context field in the Initial Report Part Settings area of the Report Options dialog box.

Returns:
The initial data context as a String.

getInitialReportPartName

java.lang.String getInitialReportPartName()

Returns the initial report part name for the report part that is displayed.

Note: This method returns the value of the Object Name field in the Initial Report Part Settings area of the Report Options dialog box.

Returns:
The initial report part name for the report part that is displayed as a String.

getNumOfBrowsingRecords

int getNumOfBrowsingRecords()

Returns the number of records that are retrieved when using the various browse methods in the com.crystaldecisions.sdk.occa.report.application.RowsetController class to examine the contents of the report's database. The default value is 100. If this property is -1, then all records are retrieved when the report is refreshed (not recommended).

Returns:
The number of records that are retrieved when using the various browse methods in the com.crystaldecisions.sdk.occa.report.application.RowsetController class as an int.

getReportStyle

ReportStyle getReportStyle()

For internal use only.


getRowsetBatchSize

int getRowsetBatchSize()

Returns the number of records in each batch in the rowset. The default value is 100. Specify -1 to retrieve all records in one batch.

Returns:
The number of records in each batch in the rowset as an int. The default value is 100. Specify -1 to retrieve all records in one batch.

getMaxNumOfRecords

int getMaxNumOfRecords()

Returns the maximum number of records the program can use in a report.

Returns:
The maximum number of records the program can use in a report as an int.

getRefreshCEProperties

boolean getRefreshCEProperties()

Queries the report to see if the object's settings are updated when saved to BusinessObjects Enterprise.

Returns:
true if the ReportOptions object's settings will be updated when saved to BusinessObjects Enterprise and false otherwise.

setCanSelectDistinctRecords

void setCanSelectDistinctRecords(boolean canSelectDistinctRecords)

Sets whether the report's data source supports the selection of unique records (Select Distinct) from SQL tables. If this property is set to true, then the report can use the Select Distinct option, unless setEnableSelectDistinctRecords is set to false. However, if this property is set to false, then the report does not support the Select Distinct option.

Parameters:
canSelectDistinctRecords - true if the report's data source supports the selection of unique records (Select Distinct) from SQL tables, and false otherwise.

setCanSetTableLocation

void setCanSetTableLocation(boolean canSetTableLocation)

For internal use only.


setConvertDateTimeType

void setConvertDateTimeType(ConvertDateTimeType convertDateTimeType)

For internal use only.


setEnableAsyncQuery

void setEnableAsyncQuery(boolean enableAsyncQuery)

Sets whether the program uses asynchronous queries. The program normally sends an entire query to the database server. Setting this property to true, however, allows the program and the ODBC database server (if it supports asynchronous queries) to transfer data back and forth. An advantage of using this report option is you can cancel queries during processing more easily.

Note: This method sets the value of the Perform Query Asynchronously check box in the Report Options dialog box of the Report Designer.

Parameters:
enableAsyncQuery - true if the program uses asynchronous queries, and false otherwise.

setEnablePushDownGroupBy

void setEnablePushDownGroupBy(boolean enablePushDownGroupBy)

Sets whether the program performs grouping on the server (server-side processing). Server-side processing allows you to set up a report that performs the majority of its processing on the server and pushes only relevant details to the client computer. Server-side processing provides you with a number of benefits:

The one disadvantage of server-side processing is that the report submits an SQL query for each group node (Totaller node).

Note: This method sets the value of the Perform Grouping On Server check box in the Report Options dialog box of the Report Designer. The Use Indexes Or Server For Speed check box must be selected in order to activate this option, otherwise Perform Grouping On Server is disabled.

Parameters:
enablePushDownGroupBy - true to have the program perform grouping on the server (server-side processing), and false otherwise.

setEnableSaveDataWithReport

void setEnableSaveDataWithReport(boolean enableSaveDataWithReport)

Sets whether the report definition and the underlying data are saved with the report. When this property is set to true, then when the report is opened again, it will include the data that was available the last time it was saved. When this property is set to false, the data will refresh each time the report is opened.

If you save the data with the report, your report will require more disk space, but the program will not need to retrieve the data again before it prints the report.

Note: This method sets the value of the Save Data With Report check box in the Report Options dialog box of the Report Designer.

Parameters:
enableSaveDataWithReport - true to have the current data saved with the report, and false otherwise.

setEnableSaveSummariesWithReport

void setEnableSaveSummariesWithReport(boolean enableSaveSummariesWithReport)

For internal use only.


setEnableSelectDistinctRecords

void setEnableSelectDistinctRecords(boolean enableSelectDistinctRecords)

Sets whether in the report only unique records are being selected from the SQL tables in your database. If the getCanSelectDistinctRecords() method returns false, then the data source does not support the Select Distinct feature which also means that the report does not support Select Distinct. If the getCanSelectDistinctRecords() method returns true, then you have the option of enabling or disabling the Select Distinct feature for each report.

Note: This method sets the value of the Select Distinct Records check box in the Report Options dialog box of the Report Designer.

Parameters:
enableSelectDistinctRecords - true if, in the report, only unique records are being selected from the SQL tables in your database, and false otherwise.

setEnableTranslateDOSStrings

void setEnableTranslateDOSStrings(boolean enableTranslateDOSStrings)

For internal use only.


setEnableUseCaseInsensitiveSQLData

void setEnableUseCaseInsensitiveSQLData(boolean enableUseCaseInsensitiveSQLData)

For internal use only.


setEnableUseDummyData

void setEnableUseDummyData(boolean enableUseDummyData)

For internal use only.


setEnableUseIndexForSpeed

void setEnableUseIndexForSpeed(boolean enableUseIndexForSpeed)

For internal use only.


setEnableVerifyOnEveryPrint

void setEnableVerifyOnEveryPrint(boolean enableVerifyOnEveryPrint)

Sets whether the report refreshes with the current version of the active database (unless it is a stored procedure) and resets its record buffers to the current record size the first time you refresh it per session.

Note: This method sets the value of the Verify on First Refresh check box in the Report Options dialog box of the Report Designer.

Parameters:
enableVerifyOnEveryPrint - true if the active database is verified when the report is first refreshed in a session, and false otherwise.

setInitialDataContext

void setInitialDataContext(java.lang.String newVal)

Sets the initial data context with which the report is displayed. For example, a report based on data that is grouped by country might have an initial data context of England if the report was designed to display information for this country when opened.

Note: This method sets the value of the Data Context field in the Initial Report Part Settings area of the Report Options dialog box.

Parameters:
newVal - The initial data context as a String.

setInitialReportPartName

void setInitialReportPartName(java.lang.String newVal)

Sets the initial report part name for the report part that is displayed.

Note: This method sets the value of the Object Name field in the Initial Report Part Settings area of the Report Options dialog box.

Parameters:
newVal - The initial report part name for the report part that is displayed as a String.

setMaxNumOfRecords

void setMaxNumOfRecords(int maxNumOfRecords)

Sets the maximum number of records the program can use in a report.

Parameters:
maxNumOfRecords - The maximum number of records the program can use in a report as an int.

setNumOfBrowsingRecords

void setNumOfBrowsingRecords(int newNumOfBrowsingRecords)

Sets the number of records that are retrieved when using the various browse methods in the com.crystaldecisions.sdk.occa.report.application.RowsetController class to examine the contents of the report's database. The default value is 100. If this property is -1, then all records are retrieved when the report is refreshed (not recommended).

Parameters:
newNumOfBrowsingRecords - The number of records that are retrieved when using the various browse methods in the com.crystaldecisions.sdk.occa.report.application.RowsetController class as an int.

setReportStyle

@Deprecated
void setReportStyle(ReportStyle newReportStyle)
Deprecated. 

For internal use only.


setRowsetBatchSize

void setRowsetBatchSize(int newRowsetBatchSize)

Sets the number of records in each batch in the rowset. The default value is 100. Specify -1 to retrieve all records in one batch.

Parameters:
newRowsetBatchSize - The number of records in each batch in the rowset as an int. The default value is 100. Specify -1 to retrieve all records in one batch.

getEnableTranslateDOSMemos

boolean getEnableTranslateDOSMemos()

For internal use only.


getNumOfCachedBatches

int getNumOfCachedBatches()

Returns the default number of rowset batches that are cached in the RowsetCursor. The RowsetCursor object inherits this number. The default value is -1, which means that all batches are cached. If you are iterating through a large data set, you may want to set this value to a positive integer. For example, if you set the value to 2, then only two batches will be kept in memory.

Returns:
The default number of rowset batches that are cached in the RowsetCursor as an int.

setEnableTranslateDOSMemos

void setEnableTranslateDOSMemos(boolean enableTranlateDOSMemos)

For internal use only.


setNumOfCachedBatches

void setNumOfCachedBatches(int newNumOfCachedBatches)

Sets the default number of rowset batches that are cached in the RowsetCursor. The RowsetCursor object inherits this number. The default value is -1, which means that all batches are cached. If you are iterating through a large data set, you may want to set this value to a positive integer. For example, if you set the value to 2, then only two batches will be kept in memory.

Parameters:
newNumOfCachedBatches - The default number of rowset batches that are cached in the RowsetCursor as an int.

setRefreshCEProperties

void setRefreshCEProperties(boolean refreshCEProperties)

Sets the value of refreshCEProperties to true if the object's settings are updated when saved to BusinessObjects Enterprise and to false.

Parameters:
refreshCEProperties - true if the ReportOptions object's settings will be updated when saved to BusinessObjects Enterprise and false otherwise.

setErrorOnMaxNumOfRecords

void setErrorOnMaxNumOfRecords(boolean errorOnMaxNumOfRecords)

Sets the value of errorOnMaxNumOfRecords to true if an error message is displayed and the report fails when the maximum number of records is reached.

If this property is set to false, no error message is displayed and the report runs successfully, but the number of records returned is truncated when the record limit specified by setMaxNumOfRecords is reached. The default value is true.

Parameters:
errorOnMaxNumOfRecords - true if an error message is displayed and the report fails when the maximum number of records is reached.

getErrorOnMaxNumOfRecords

boolean getErrorOnMaxNumOfRecords()

Returns true if an error message is displayed and the report fails when the maximum number of records is reached.

If this property returns false, no error message is displayed and the report runs successfully, but the number of records returned is truncated when the record limit specified by setMaxNumOfRecords is reached.

Returns:
true if an error message is displayed and the report fails when the maximum number of records is reached, and false otherwise.

getConvertDBNullToDefault

boolean getConvertDBNullToDefault()

setConvertDBNullToDefault

void setConvertDBNullToDefault(boolean bConvertDBNullToDefault)

getConvertOtherNullToDefault

boolean getConvertOtherNullToDefault()

setConvertOtherNullToDefault

void setConvertOtherNullToDefault(boolean bConvertOtherNullToDefault)

getShowAllHeadersOnDrillDown

boolean getShowAllHeadersOnDrillDown()

setShowAllHeadersOnDrillDown

void setShowAllHeadersOnDrillDown(boolean bShowAllHeadersOnDrillDown)

getVerifyStoredProcOnFirstRefresh

boolean getVerifyStoredProcOnFirstRefresh()

Returns if refresh stored procedure on first refresh

Returns:
The VerifyStoredProcOnFirstRefresh as aboolean.


setVerifyStoredProcOnFirstRefresh

void setVerifyStoredProcOnFirstRefresh(boolean bVerifyStoredProcOnFirstRefresh)

set value if refresh stored procedure on first refresh

Parameters:
bVerifyStoredProcOnFirstRefresh - as aboolean.


getRespectKeepGroupTogetherOnFirstPage

boolean getRespectKeepGroupTogetherOnFirstPage()

Returns if respect keep group together on first page

Returns:
The RespectKeepGroupTogetherOnFirstPage as aboolean.


setRespectKeepGroupTogetherOnFirstPage

void setRespectKeepGroupTogetherOnFirstPage(boolean bRespectKeepGroupTogetherOnFirstPage)

set value if respect keep group together on first page

Parameters:
bRespectKeepGroupTogetherOnFirstPage - as aboolean.


getSuppressPrintingIfNoRecords

boolean getSuppressPrintingIfNoRecords()

Returns if suppress printing when no records

Returns:
The SuppressPrintingIfNoRecords as aboolean.


setSuppressPrintingIfNoRecords

void setSuppressPrintingIfNoRecords(boolean bSuppressPrintingIfNoRecords)

set value if suppress printing when no records

Parameters:
bSuppressPrintingIfNoRecords - as aboolean.


getCreateGroupTree

boolean getCreateGroupTree()

Returns if create group tree

Returns:
The CreateGroupTree as aboolean.


setCreateGroupTree

void setCreateGroupTree(boolean bCreateGroupTree)

set value if create group tree

Parameters:
bCreateGroupTree - as aboolean.


getZoomMode

ZoomMode getZoomMode()

returns the current zoom mode

Returns:
ZoomMode enum instance

setZoomMode

void setZoomMode(ZoomMode zoomMode)

set current zoom mode

Parameters:
zoomMode - new zooom mode