com.crystaldecisions.sdk.occa.report.document
Class ReportOptions

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.document.ReportOptions
All Implemented Interfaces:
IReportOptions, IClone

public class ReportOptions
extends java.lang.Object
implements IClone, IReportOptions

This object 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. Use IReportOptions to access these methods.


Constructor Summary
ReportOptions()
           
ReportOptions(IReportOptions src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           
 boolean getAlwaysSortLocally()
          For internal use only
 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()
          For internal use only
 boolean getConvertOtherNullToDefault()
          For internal use only
 boolean getCreateGroupTree()
          For internal use only
 boolean getEnableAsyncQuery()
          Returns whether the program uses asynchronous queries.
 boolean getEnableBrowseDistinctData()
          For internal use only
 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 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 getPromptForHyperlinks()
          For internal use only
 boolean getRefreshCEProperties()
           Queries the report to see if the object's settings are updated when saved to SAP BusinessObjects Enterprise.
 ReportStyle getReportStyle()
          For internal use only.
 boolean getRespectKeepGroupTogetherOnFirstPage()
          For internal use only
 int getRowsetBatchSize()
           Returns the number of records in each batch in the rowset.
 boolean getShowAllHeadersOnDrillDown()
          For internal use only
 boolean getShowTriggeredAlerts()
          For internal use only
 boolean getSuppressPrintingIfNoRecords()
          For internal use only
 boolean getVerifyStoredProcOnFirstRefresh()
          For internal use only
 ZoomMode getZoomMode()
          For internal use only
 boolean hasContent(java.lang.Object srcReportOptions)
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           
 void setAlwaysSortLocally(boolean bAlwaysSortLocally)
          For internal use only
 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)
          For internal use only
 void setConvertOtherNullToDefault(boolean bConvertOtherNullToDefault)
          For internal use only
 void setCreateGroupTree(boolean bCreateGroupTree)
          For internal use only
 void setEnableAsyncQuery(boolean enableAsyncQuery)
          Sets whether the program uses asynchronous queries.
 void setEnableBrowseDistinctData(boolean enableBrowseDistinctData)
          For internal use only
 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 newInitialDataContext)
          Sets the initial data context with which the report is displayed.
 void setInitialReportPartName(java.lang.String newInitialReportPartName)
          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 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 setPromptForHyperlinks(boolean bPromptForHyperlinks)
          For internal use only
 void setRefreshCEProperties(boolean refreshCEProperties)
           Sets the value of refreshCEProperties to true if the object's settings are updated when saved to SAP BusinessObjects Enterprise and to false.
 void setReportStyle(ReportStyle newReportStyle)
          Deprecated. 
 void setRespectKeepGroupTogetherOnFirstPage(boolean bRespectKeepGroupTogetherOnFirstPage)
          For internal use only
 void setRowsetBatchSize(int newRowsetBatchSize)
           Sets the number of records in each batch in the rowset.
 void setShowAllHeadersOnDrillDown(boolean bShowAllHeadersOnDrillDown)
          For internal use only
 void setShowTriggeredAlerts(boolean bShowTriggeredAlerts)
          For internal use only
 void setSuppressPrintingIfNoRecords(boolean bSuppressPrintingIfNoRecords)
          For internal use only
 void setVerifyStoredProcOnFirstRefresh(boolean bVerifyStoredProcOnFirstRefresh)
          For internal use only
 void setZoomMode(ZoomMode zoomMode)
          For internal use only
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportOptions

public ReportOptions(IReportOptions src)

ReportOptions

public ReportOptions()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

getCanSelectDistinctRecords

public boolean getCanSelectDistinctRecords()
Description copied from interface: IReportOptions

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.

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

getCanSetTableLocation

public boolean getCanSetTableLocation()
Description copied from interface: IReportOptions

For internal use only.

Specified by:
getCanSetTableLocation in interface IReportOptions

getConvertDateTimeType

public ConvertDateTimeType getConvertDateTimeType()
Description copied from interface: IReportOptions

For internal use only.

Specified by:
getConvertDateTimeType in interface IReportOptions

getEnableAsyncQuery

public boolean getEnableAsyncQuery()
Description copied from interface: IReportOptions

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.

Specified by:
getEnableAsyncQuery in interface IReportOptions
Returns:
true if the program uses asynchronous queries, and false otherwise.

getEnablePushDownGroupBy

public boolean getEnablePushDownGroupBy()
Description copied from interface: IReportOptions

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.

Specified by:
getEnablePushDownGroupBy in interface IReportOptions
Returns:
true if the program performs grouping on the server (server-side processing), and false otherwise.

getEnableSaveDataWithReport

public boolean getEnableSaveDataWithReport()
Description copied from interface: IReportOptions

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.

Specified by:
getEnableSaveDataWithReport in interface IReportOptions
Returns:
true if the current data is saved with the report, and false otherwise.

getEnableSaveSummariesWithReport

public boolean getEnableSaveSummariesWithReport()
Description copied from interface: IReportOptions

For internal use only.

Specified by:
getEnableSaveSummariesWithReport in interface IReportOptions

getEnableSelectDistinctRecords

public boolean getEnableSelectDistinctRecords()
Description copied from interface: IReportOptions

Returns whether in the report only unique records are being selected from the SQL tables in your database. If the IReportOptions.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 IReportOptions.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.

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

getEnableBrowseDistinctData

public boolean getEnableBrowseDistinctData()
Description copied from interface: IReportOptions
For internal use only

Specified by:
getEnableBrowseDistinctData in interface IReportOptions

getEnableTranslateDOSMemos

public boolean getEnableTranslateDOSMemos()
Description copied from interface: IReportOptions

For internal use only.

Specified by:
getEnableTranslateDOSMemos in interface IReportOptions

getEnableTranslateDOSStrings

public boolean getEnableTranslateDOSStrings()
Description copied from interface: IReportOptions

For internal use only.

Specified by:
getEnableTranslateDOSStrings in interface IReportOptions

getEnableUseCaseInsensitiveSQLData

public boolean getEnableUseCaseInsensitiveSQLData()
Description copied from interface: IReportOptions

For internal use only.

Specified by:
getEnableUseCaseInsensitiveSQLData in interface IReportOptions

getEnableUseDummyData

public boolean getEnableUseDummyData()
Description copied from interface: IReportOptions

For internal use only.

Specified by:
getEnableUseDummyData in interface IReportOptions

getEnableUseIndexForSpeed

public boolean getEnableUseIndexForSpeed()
Description copied from interface: IReportOptions

For internal use only.

Specified by:
getEnableUseIndexForSpeed in interface IReportOptions

getEnableVerifyOnEveryPrint

public boolean getEnableVerifyOnEveryPrint()
Description copied from interface: IReportOptions

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.

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

getInitialDataContext

public java.lang.String getInitialDataContext()
Description copied from interface: IReportOptions

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.

Specified by:
getInitialDataContext in interface IReportOptions
Returns:
The initial data context as a String.

getInitialReportPartName

public java.lang.String getInitialReportPartName()
Description copied from interface: IReportOptions

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.

Specified by:
getInitialReportPartName in interface IReportOptions
Returns:
The initial report part name for the report part that is displayed as a String.

getMaxNumOfRecords

public int getMaxNumOfRecords()
Description copied from interface: IReportOptions

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

Specified by:
getMaxNumOfRecords in interface IReportOptions
Returns:
The maximum number of records the program can use in a report as an int.

getNumOfBrowsingRecords

public int getNumOfBrowsingRecords()
Description copied from interface: IReportOptions

Returns the number of records that are retrieved when using the various browse methods in the 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).

Specified by:
getNumOfBrowsingRecords in interface IReportOptions
Returns:
The number of records that are retrieved when using the various browse methods in the RowsetController class as an int.

getNumOfCachedBatches

public int getNumOfCachedBatches()
Description copied from interface: IReportOptions

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.

Specified by:
getNumOfCachedBatches in interface IReportOptions
Returns:
The default number of rowset batches that are cached in the RowsetCursor as an int.

getReportStyle

public ReportStyle getReportStyle()
Description copied from interface: IReportOptions

For internal use only.

Specified by:
getReportStyle in interface IReportOptions

getRowsetBatchSize

public int getRowsetBatchSize()
Description copied from interface: IReportOptions

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.

Specified by:
getRowsetBatchSize in interface IReportOptions
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.

getRefreshCEProperties

public boolean getRefreshCEProperties()
Description copied from interface: IReportOptions

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

Specified by:
getRefreshCEProperties in interface IReportOptions
Returns:
true if the ReportOptions object's settings will be updated when saved to SAP BusinessObjects Enterprise and false otherwise.

getErrorOnMaxNumOfRecords

public boolean getErrorOnMaxNumOfRecords()
Description copied from interface: IReportOptions

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.

Specified by:
getErrorOnMaxNumOfRecords in interface IReportOptions
Returns:
true if an error message is displayed and the report fails when the maximum number of records is reached, and false otherwise.

getConvertDBNullToDefault

public boolean getConvertDBNullToDefault()
For internal use only

Specified by:
getConvertDBNullToDefault in interface IReportOptions

getConvertOtherNullToDefault

public boolean getConvertOtherNullToDefault()
For internal use only

Specified by:
getConvertOtherNullToDefault in interface IReportOptions

getShowAllHeadersOnDrillDown

public boolean getShowAllHeadersOnDrillDown()
For internal use only

Specified by:
getShowAllHeadersOnDrillDown in interface IReportOptions

getVerifyStoredProcOnFirstRefresh

public boolean getVerifyStoredProcOnFirstRefresh()
For internal use only

Specified by:
getVerifyStoredProcOnFirstRefresh in interface IReportOptions
Returns:
The VerifyStoredProcOnFirstRefresh as aboolean.


getRespectKeepGroupTogetherOnFirstPage

public boolean getRespectKeepGroupTogetherOnFirstPage()
For internal use only

Specified by:
getRespectKeepGroupTogetherOnFirstPage in interface IReportOptions
Returns:
The RespectKeepGroupTogetherOnFirstPage as aboolean.


getSuppressPrintingIfNoRecords

public boolean getSuppressPrintingIfNoRecords()
For internal use only

Specified by:
getSuppressPrintingIfNoRecords in interface IReportOptions
Returns:
The SuppressPrintingIfNoRecords as aboolean.


getAlwaysSortLocally

public boolean getAlwaysSortLocally()
For internal use only

Specified by:
getAlwaysSortLocally in interface IReportOptions
Returns:
The alwaysSortLocally as aboolean.


getCreateGroupTree

public boolean getCreateGroupTree()
For internal use only

Specified by:
getCreateGroupTree in interface IReportOptions
Returns:
The CreateGroupTree as aboolean.


getShowTriggeredAlerts

public boolean getShowTriggeredAlerts()
For internal use only

Specified by:
getShowTriggeredAlerts in interface IReportOptions

getZoomMode

public ZoomMode getZoomMode()
For internal use only

Specified by:
getZoomMode in interface IReportOptions
Returns:
ZoomMode enum instance

hasContent

public boolean hasContent(java.lang.Object srcReportOptions)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Throws:
java.io.IOException

setCanSelectDistinctRecords

public void setCanSelectDistinctRecords(boolean canSelectDistinctRecords)
Description copied from interface: IReportOptions

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.

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

setCanSetTableLocation

public void setCanSetTableLocation(boolean canSetTableLocation)
Description copied from interface: IReportOptions

For internal use only.

Specified by:
setCanSetTableLocation in interface IReportOptions

setConvertDateTimeType

public void setConvertDateTimeType(ConvertDateTimeType convertDateTimeType)
Description copied from interface: IReportOptions

For internal use only.

Specified by:
setConvertDateTimeType in interface IReportOptions

setEnableAsyncQuery

public void setEnableAsyncQuery(boolean enableAsyncQuery)
Description copied from interface: IReportOptions

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.

Specified by:
setEnableAsyncQuery in interface IReportOptions
Parameters:
enableAsyncQuery - true if the program uses asynchronous queries, and false otherwise.

setEnablePushDownGroupBy

public void setEnablePushDownGroupBy(boolean enablePushDownGroupBy)
Description copied from interface: IReportOptions

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.

Specified by:
setEnablePushDownGroupBy in interface IReportOptions
Parameters:
enablePushDownGroupBy - true to have the program perform grouping on the server (server-side processing), and false otherwise.

setEnableSaveDataWithReport

public void setEnableSaveDataWithReport(boolean enableSaveDataWithReport)
Description copied from interface: IReportOptions

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.

Specified by:
setEnableSaveDataWithReport in interface IReportOptions
Parameters:
enableSaveDataWithReport - true to have the current data saved with the report, and false otherwise.

setEnableSaveSummariesWithReport

public void setEnableSaveSummariesWithReport(boolean enableSaveSummariesWithReport)
Description copied from interface: IReportOptions

For internal use only.

Specified by:
setEnableSaveSummariesWithReport in interface IReportOptions

setEnableSelectDistinctRecords

public void setEnableSelectDistinctRecords(boolean enableSelectDistinctRecords)
Description copied from interface: IReportOptions

Sets whether in the report only unique records are being selected from the SQL tables in your database. If the IReportOptions.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 IReportOptions.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.

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

setEnableBrowseDistinctData

public void setEnableBrowseDistinctData(boolean enableBrowseDistinctData)
Description copied from interface: IReportOptions
For internal use only

Specified by:
setEnableBrowseDistinctData in interface IReportOptions

setEnableTranslateDOSMemos

public void setEnableTranslateDOSMemos(boolean enableTranlateDOSMemos)
Description copied from interface: IReportOptions

For internal use only.

Specified by:
setEnableTranslateDOSMemos in interface IReportOptions

setEnableTranslateDOSStrings

public void setEnableTranslateDOSStrings(boolean enableTranslateDOSStrings)
Description copied from interface: IReportOptions

For internal use only.

Specified by:
setEnableTranslateDOSStrings in interface IReportOptions

setEnableUseCaseInsensitiveSQLData

public void setEnableUseCaseInsensitiveSQLData(boolean enableUseCaseInsensitiveSQLData)
Description copied from interface: IReportOptions

For internal use only.

Specified by:
setEnableUseCaseInsensitiveSQLData in interface IReportOptions

setEnableUseDummyData

public void setEnableUseDummyData(boolean enableUseDummyData)
Description copied from interface: IReportOptions

For internal use only.

Specified by:
setEnableUseDummyData in interface IReportOptions

setEnableUseIndexForSpeed

public void setEnableUseIndexForSpeed(boolean enableUseIndexForSpeed)
Description copied from interface: IReportOptions

For internal use only.

Specified by:
setEnableUseIndexForSpeed in interface IReportOptions

setEnableVerifyOnEveryPrint

public void setEnableVerifyOnEveryPrint(boolean enableVerifyOnEveryPrint)
Description copied from interface: IReportOptions

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.

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

setInitialDataContext

public void setInitialDataContext(java.lang.String newInitialDataContext)
Description copied from interface: IReportOptions

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.

Specified by:
setInitialDataContext in interface IReportOptions
Parameters:
newInitialDataContext - The initial data context as a String.

setInitialReportPartName

public void setInitialReportPartName(java.lang.String newInitialReportPartName)
Description copied from interface: IReportOptions

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.

Specified by:
setInitialReportPartName in interface IReportOptions
Parameters:
newInitialReportPartName - The initial report part name for the report part that is displayed as a String.

setMaxNumOfRecords

public void setMaxNumOfRecords(int maxNumOfRecords)
Description copied from interface: IReportOptions

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

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

setNumOfBrowsingRecords

public void setNumOfBrowsingRecords(int newNumOfBrowsingRecords)
Description copied from interface: IReportOptions

Sets the number of records that are retrieved when using the various browse methods in the 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).

Specified by:
setNumOfBrowsingRecords in interface IReportOptions
Parameters:
newNumOfBrowsingRecords - The number of records that are retrieved when using the various browse methods in the RowsetController class as an int.

setNumOfCachedBatches

public void setNumOfCachedBatches(int newNumOfCachedBatches)
Description copied from interface: IReportOptions

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.

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

setReportStyle

@Deprecated
public void setReportStyle(ReportStyle newReportStyle)
Deprecated. 

Description copied from interface: IReportOptions

For internal use only.

Specified by:
setReportStyle in interface IReportOptions

setRowsetBatchSize

public void setRowsetBatchSize(int newRowsetBatchSize)
Description copied from interface: IReportOptions

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.

Specified by:
setRowsetBatchSize in interface IReportOptions
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.

setRefreshCEProperties

public void setRefreshCEProperties(boolean refreshCEProperties)
Description copied from interface: IReportOptions

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

Specified by:
setRefreshCEProperties in interface IReportOptions
Parameters:
refreshCEProperties - true if the ReportOptions object's settings will be updated when saved to SAP BusinessObjects Enterprise and false otherwise.

setErrorOnMaxNumOfRecords

public void setErrorOnMaxNumOfRecords(boolean errorOnMaxNumOfRecords)
Description copied from interface: IReportOptions

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.

Specified by:
setErrorOnMaxNumOfRecords in interface IReportOptions
Parameters:
errorOnMaxNumOfRecords - true if an error message is displayed and the report fails when the maximum number of records is reached.

setConvertDBNullToDefault

public void setConvertDBNullToDefault(boolean bConvertDBNullToDefault)
For internal use only

Specified by:
setConvertDBNullToDefault in interface IReportOptions

setConvertOtherNullToDefault

public void setConvertOtherNullToDefault(boolean bConvertOtherNullToDefault)
For internal use only

Specified by:
setConvertOtherNullToDefault in interface IReportOptions

setShowAllHeadersOnDrillDown

public void setShowAllHeadersOnDrillDown(boolean bShowAllHeadersOnDrillDown)
For internal use only

Specified by:
setShowAllHeadersOnDrillDown in interface IReportOptions

setVerifyStoredProcOnFirstRefresh

public void setVerifyStoredProcOnFirstRefresh(boolean bVerifyStoredProcOnFirstRefresh)
For internal use only

Specified by:
setVerifyStoredProcOnFirstRefresh in interface IReportOptions
Parameters:
bVerifyStoredProcOnFirstRefresh - as aboolean.


setRespectKeepGroupTogetherOnFirstPage

public void setRespectKeepGroupTogetherOnFirstPage(boolean bRespectKeepGroupTogetherOnFirstPage)
For internal use only

Specified by:
setRespectKeepGroupTogetherOnFirstPage in interface IReportOptions
Parameters:
bRespectKeepGroupTogetherOnFirstPage - as aboolean.


setSuppressPrintingIfNoRecords

public void setSuppressPrintingIfNoRecords(boolean bSuppressPrintingIfNoRecords)
For internal use only

Specified by:
setSuppressPrintingIfNoRecords in interface IReportOptions
Parameters:
bSuppressPrintingIfNoRecords - as aboolean.


setAlwaysSortLocally

public void setAlwaysSortLocally(boolean bAlwaysSortLocally)
For internal use only

Specified by:
setAlwaysSortLocally in interface IReportOptions
Parameters:
bAlwaysSortLocally - as aboolean.


setCreateGroupTree

public void setCreateGroupTree(boolean bCreateGroupTree)
For internal use only

Specified by:
setCreateGroupTree in interface IReportOptions
Parameters:
bCreateGroupTree - as aboolean.


setShowTriggeredAlerts

public void setShowTriggeredAlerts(boolean bShowTriggeredAlerts)
For internal use only

Specified by:
setShowTriggeredAlerts in interface IReportOptions

setZoomMode

public void setZoomMode(ZoomMode zoomMode)
For internal use only

Specified by:
setZoomMode in interface IReportOptions
Parameters:
zoomMode - new zooom mode

getPromptForHyperlinks

public boolean getPromptForHyperlinks()
For internal use only

Specified by:
getPromptForHyperlinks in interface IReportOptions
Returns:
The bPromptForHyperlinks as aboolean.


setPromptForHyperlinks

public void setPromptForHyperlinks(boolean bPromptForHyperlinks)
For internal use only

Specified by:
setPromptForHyperlinks in interface IReportOptions
Parameters:
bPromptForHyperlinks - as aboolean.


startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)