|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.document.ReportOptions
public class ReportOptions
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 |
|---|
public ReportOptions(IReportOptions src)
public ReportOptions()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
public java.lang.Object createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
public void endElement(java.lang.String eleName,
java.util.Map objState)
public boolean getCanSelectDistinctRecords()
IReportOptionsReturns 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.
getCanSelectDistinctRecords in interface IReportOptionstrue if the report's data source supports the selection of
unique records (Select Distinct) from SQL tables,
and false otherwise.public boolean getCanSetTableLocation()
IReportOptionsFor internal use only.
getCanSetTableLocation in interface IReportOptionspublic ConvertDateTimeType getConvertDateTimeType()
IReportOptionsFor internal use only.
getConvertDateTimeType in interface IReportOptionspublic boolean getEnableAsyncQuery()
IReportOptionsReturns 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.
getEnableAsyncQuery in interface IReportOptionstrue if the program uses asynchronous queries, and false otherwise.public boolean getEnablePushDownGroupBy()
IReportOptionsReturns 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:
Note: This method returns the value of the Perform Grouping On Server check box in the Report Options dialog box of the Report Designer.
getEnablePushDownGroupBy in interface IReportOptionstrue if the program performs grouping on the server
(server-side processing), and false otherwise.public boolean getEnableSaveDataWithReport()
IReportOptionsReturns 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.
getEnableSaveDataWithReport in interface IReportOptionstrue if the current data is saved with the report,
and false otherwise.public boolean getEnableSaveSummariesWithReport()
IReportOptionsFor internal use only.
getEnableSaveSummariesWithReport in interface IReportOptionspublic boolean getEnableSelectDistinctRecords()
IReportOptionsReturns 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.
getEnableSelectDistinctRecords in interface IReportOptionstrue if, in the report, only unique records are being selected from the
SQL tables in your database, and false otherwise.public boolean getEnableBrowseDistinctData()
IReportOptions
getEnableBrowseDistinctData in interface IReportOptionspublic boolean getEnableTranslateDOSMemos()
IReportOptionsFor internal use only.
getEnableTranslateDOSMemos in interface IReportOptionspublic boolean getEnableTranslateDOSStrings()
IReportOptionsFor internal use only.
getEnableTranslateDOSStrings in interface IReportOptionspublic boolean getEnableUseCaseInsensitiveSQLData()
IReportOptionsFor internal use only.
getEnableUseCaseInsensitiveSQLData in interface IReportOptionspublic boolean getEnableUseDummyData()
IReportOptionsFor internal use only.
getEnableUseDummyData in interface IReportOptionspublic boolean getEnableUseIndexForSpeed()
IReportOptionsFor internal use only.
getEnableUseIndexForSpeed in interface IReportOptionspublic boolean getEnableVerifyOnEveryPrint()
IReportOptionsReturns 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.
getEnableVerifyOnEveryPrint in interface IReportOptionstrue if the active database is verified when the report is first refreshed in a session,
and false otherwise.public java.lang.String getInitialDataContext()
IReportOptionsReturns 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.
getInitialDataContext in interface IReportOptionsString.public java.lang.String getInitialReportPartName()
IReportOptionsReturns 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.
getInitialReportPartName in interface IReportOptionsString.public int getMaxNumOfRecords()
IReportOptionsReturns the maximum number of records the program can use in a report.
getMaxNumOfRecords in interface IReportOptionsint.public int getNumOfBrowsingRecords()
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).
getNumOfBrowsingRecords in interface IReportOptionsRowsetController
class as an int.public int getNumOfCachedBatches()
IReportOptionsReturns 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.
getNumOfCachedBatches in interface IReportOptionsRowsetCursor as an int.public ReportStyle getReportStyle()
IReportOptionsFor internal use only.
getReportStyle in interface IReportOptionspublic int getRowsetBatchSize()
IReportOptionsReturns the number of records in each batch in the rowset. The default value is 100. Specify -1 to retrieve all records in one batch.
getRowsetBatchSize in interface IReportOptionsint. The default value is 100. Specify -1 to retrieve all records in one batch.public boolean getRefreshCEProperties()
IReportOptionsQueries the report to see if the object's settings are updated when saved to SAP BusinessObjects Enterprise.
getRefreshCEProperties in interface IReportOptionstrue if the ReportOptions object's settings will
be updated when saved to SAP BusinessObjects Enterprise and false otherwise.public boolean getErrorOnMaxNumOfRecords()
IReportOptionsReturns 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.
getErrorOnMaxNumOfRecords in interface IReportOptionstrue if an error message is displayed and the report fails when the maximum number
of records is reached, and false otherwise.public boolean getConvertDBNullToDefault()
getConvertDBNullToDefault in interface IReportOptionspublic boolean getConvertOtherNullToDefault()
getConvertOtherNullToDefault in interface IReportOptionspublic boolean getShowAllHeadersOnDrillDown()
getShowAllHeadersOnDrillDown in interface IReportOptionspublic boolean getVerifyStoredProcOnFirstRefresh()
getVerifyStoredProcOnFirstRefresh in interface IReportOptionsboolean. public boolean getRespectKeepGroupTogetherOnFirstPage()
getRespectKeepGroupTogetherOnFirstPage in interface IReportOptionsboolean. public boolean getSuppressPrintingIfNoRecords()
getSuppressPrintingIfNoRecords in interface IReportOptionsboolean. public boolean getAlwaysSortLocally()
getAlwaysSortLocally in interface IReportOptionsboolean. public boolean getCreateGroupTree()
getCreateGroupTree in interface IReportOptionsboolean. public boolean getShowTriggeredAlerts()
getShowTriggeredAlerts in interface IReportOptionspublic ZoomMode getZoomMode()
getZoomMode in interface IReportOptionspublic boolean hasContent(java.lang.Object srcReportOptions)
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
java.io.IOExceptionpublic void setCanSelectDistinctRecords(boolean canSelectDistinctRecords)
IReportOptionsSets 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.
setCanSelectDistinctRecords in interface IReportOptionscanSelectDistinctRecords - true if the report's data source supports the selection of
unique records (Select Distinct) from SQL tables,
and false otherwise.public void setCanSetTableLocation(boolean canSetTableLocation)
IReportOptionsFor internal use only.
setCanSetTableLocation in interface IReportOptionspublic void setConvertDateTimeType(ConvertDateTimeType convertDateTimeType)
IReportOptionsFor internal use only.
setConvertDateTimeType in interface IReportOptionspublic void setEnableAsyncQuery(boolean enableAsyncQuery)
IReportOptionsSets 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.
setEnableAsyncQuery in interface IReportOptionsenableAsyncQuery - true if the program uses asynchronous queries, and
false otherwise.public void setEnablePushDownGroupBy(boolean enablePushDownGroupBy)
IReportOptionsSets 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:
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.
setEnablePushDownGroupBy in interface IReportOptionsenablePushDownGroupBy - true to have the program perform grouping on the server
(server-side processing), and false otherwise.public void setEnableSaveDataWithReport(boolean enableSaveDataWithReport)
IReportOptionsSets 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.
setEnableSaveDataWithReport in interface IReportOptionsenableSaveDataWithReport - true to have the current data saved with the report,
and false otherwise.public void setEnableSaveSummariesWithReport(boolean enableSaveSummariesWithReport)
IReportOptionsFor internal use only.
setEnableSaveSummariesWithReport in interface IReportOptionspublic void setEnableSelectDistinctRecords(boolean enableSelectDistinctRecords)
IReportOptionsSets 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.
setEnableSelectDistinctRecords in interface IReportOptionsenableSelectDistinctRecords - true if, in the report, only unique records are being selected from the
SQL tables in your database, and false otherwise.public void setEnableBrowseDistinctData(boolean enableBrowseDistinctData)
IReportOptions
setEnableBrowseDistinctData in interface IReportOptionspublic void setEnableTranslateDOSMemos(boolean enableTranlateDOSMemos)
IReportOptionsFor internal use only.
setEnableTranslateDOSMemos in interface IReportOptionspublic void setEnableTranslateDOSStrings(boolean enableTranslateDOSStrings)
IReportOptionsFor internal use only.
setEnableTranslateDOSStrings in interface IReportOptionspublic void setEnableUseCaseInsensitiveSQLData(boolean enableUseCaseInsensitiveSQLData)
IReportOptionsFor internal use only.
setEnableUseCaseInsensitiveSQLData in interface IReportOptionspublic void setEnableUseDummyData(boolean enableUseDummyData)
IReportOptionsFor internal use only.
setEnableUseDummyData in interface IReportOptionspublic void setEnableUseIndexForSpeed(boolean enableUseIndexForSpeed)
IReportOptionsFor internal use only.
setEnableUseIndexForSpeed in interface IReportOptionspublic void setEnableVerifyOnEveryPrint(boolean enableVerifyOnEveryPrint)
IReportOptionsSets 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.
setEnableVerifyOnEveryPrint in interface IReportOptionsenableVerifyOnEveryPrint - true if the active database is verified when the report is first refreshed in a session,
and false otherwise.public void setInitialDataContext(java.lang.String newInitialDataContext)
IReportOptionsSets 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.
setInitialDataContext in interface IReportOptionsnewInitialDataContext - The initial data context as a String.public void setInitialReportPartName(java.lang.String newInitialReportPartName)
IReportOptionsSets 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.
setInitialReportPartName in interface IReportOptionsnewInitialReportPartName - The initial report part name for the report part that is displayed as a String.public void setMaxNumOfRecords(int maxNumOfRecords)
IReportOptionsSets the maximum number of records the program can use in a report.
setMaxNumOfRecords in interface IReportOptionsmaxNumOfRecords - The maximum number of records the program can use in a report
as an int.public void setNumOfBrowsingRecords(int newNumOfBrowsingRecords)
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).
setNumOfBrowsingRecords in interface IReportOptionsnewNumOfBrowsingRecords - The number of records that are retrieved when using the various browse methods
in the RowsetController
class as an int.public void setNumOfCachedBatches(int newNumOfCachedBatches)
IReportOptionsSets 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.
setNumOfCachedBatches in interface IReportOptionsnewNumOfCachedBatches - The default number of rowset batches that are cached in the
RowsetCursor as an int.@Deprecated public void setReportStyle(ReportStyle newReportStyle)
IReportOptionsFor internal use only.
setReportStyle in interface IReportOptionspublic void setRowsetBatchSize(int newRowsetBatchSize)
IReportOptionsSets the number of records in each batch in the rowset. The default value is 100. Specify -1 to retrieve all records in one batch.
setRowsetBatchSize in interface IReportOptionsnewRowsetBatchSize - 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.public void setRefreshCEProperties(boolean refreshCEProperties)
IReportOptions
Sets the value of refreshCEProperties to true
if the object's settings are updated when saved to SAP BusinessObjects Enterprise and to false.
setRefreshCEProperties in interface IReportOptionsrefreshCEProperties - true if the ReportOptions object's settings will
be updated when saved to SAP BusinessObjects Enterprise and false otherwise.public void setErrorOnMaxNumOfRecords(boolean errorOnMaxNumOfRecords)
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.
setErrorOnMaxNumOfRecords in interface IReportOptionserrorOnMaxNumOfRecords - true if an error message is displayed and the report fails
when the maximum number of records is reached.public void setConvertDBNullToDefault(boolean bConvertDBNullToDefault)
setConvertDBNullToDefault in interface IReportOptionspublic void setConvertOtherNullToDefault(boolean bConvertOtherNullToDefault)
setConvertOtherNullToDefault in interface IReportOptionspublic void setShowAllHeadersOnDrillDown(boolean bShowAllHeadersOnDrillDown)
setShowAllHeadersOnDrillDown in interface IReportOptionspublic void setVerifyStoredProcOnFirstRefresh(boolean bVerifyStoredProcOnFirstRefresh)
setVerifyStoredProcOnFirstRefresh in interface IReportOptionsbVerifyStoredProcOnFirstRefresh - as aboolean. public void setRespectKeepGroupTogetherOnFirstPage(boolean bRespectKeepGroupTogetherOnFirstPage)
setRespectKeepGroupTogetherOnFirstPage in interface IReportOptionsbRespectKeepGroupTogetherOnFirstPage - as aboolean. public void setSuppressPrintingIfNoRecords(boolean bSuppressPrintingIfNoRecords)
setSuppressPrintingIfNoRecords in interface IReportOptionsbSuppressPrintingIfNoRecords - as aboolean. public void setAlwaysSortLocally(boolean bAlwaysSortLocally)
setAlwaysSortLocally in interface IReportOptionsbAlwaysSortLocally - as aboolean. public void setCreateGroupTree(boolean bCreateGroupTree)
setCreateGroupTree in interface IReportOptionsbCreateGroupTree - as aboolean. public void setShowTriggeredAlerts(boolean bShowTriggeredAlerts)
setShowTriggeredAlerts in interface IReportOptionspublic void setZoomMode(ZoomMode zoomMode)
setZoomMode in interface IReportOptionszoomMode - new zooom modepublic boolean getPromptForHyperlinks()
getPromptForHyperlinks in interface IReportOptionsboolean. public void setPromptForHyperlinks(boolean bPromptForHyperlinks)
setPromptForHyperlinks in interface IReportOptionsbPromptForHyperlinks - as aboolean.
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||