|
|||||||||
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)
For internal use only. |
void |
doControllerModification(java.lang.Object newObject)
|
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
void |
enumerateMembers(IMemberVisitor visitor)
|
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. |
ControllableMixin |
getControllableMixin()
|
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. |
com.crystaldecisions.sdk.occa.report.definition.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 |
getShowTriggeredAlerts()
|
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 |
boolean |
hasContent(java.lang.Object srcReportOptions)
|
boolean |
isDirectlyControllable()
|
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
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)
|
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 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 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(com.crystaldecisions.sdk.occa.report.definition.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 |
setShowTriggeredAlerts(boolean bShowTriggeredAlerts)
|
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 |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
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)
For internal use only.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public boolean getCanSelectDistinctRecords()
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.
getCanSelectDistinctRecords
in interface IReportOptions
true
if the report's data source supports the selection of
unique records (Select Distinct
) from SQL tables,
and false
otherwise.public boolean getCanSetTableLocation()
IReportOptions
For internal use only.
getCanSetTableLocation
in interface IReportOptions
public ConvertDateTimeType getConvertDateTimeType()
IReportOptions
For internal use only.
getConvertDateTimeType
in interface IReportOptions
public boolean getEnableAsyncQuery()
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.
getEnableAsyncQuery
in interface IReportOptions
true
if the program uses asynchronous queries, and false
otherwise.public boolean getEnablePushDownGroupBy()
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:
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 IReportOptions
true
if the program performs grouping on the server
(server-side processing), and false
otherwise.public boolean getEnableSaveDataWithReport()
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.
getEnableSaveDataWithReport
in interface IReportOptions
true
if the current data is saved with the report,
and false
otherwise.public boolean getEnableSaveSummariesWithReport()
IReportOptions
For internal use only.
getEnableSaveSummariesWithReport
in interface IReportOptions
public boolean getEnableSelectDistinctRecords()
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.
getEnableSelectDistinctRecords
in interface IReportOptions
true
if, in the report, only unique records are being selected from the
SQL tables in your database, and false
otherwise.public boolean getEnableTranslateDOSMemos()
IReportOptions
For internal use only.
getEnableTranslateDOSMemos
in interface IReportOptions
public boolean getEnableTranslateDOSStrings()
IReportOptions
For internal use only.
getEnableTranslateDOSStrings
in interface IReportOptions
public boolean getEnableUseCaseInsensitiveSQLData()
IReportOptions
For internal use only.
getEnableUseCaseInsensitiveSQLData
in interface IReportOptions
public boolean getEnableUseDummyData()
IReportOptions
For internal use only.
getEnableUseDummyData
in interface IReportOptions
public boolean getEnableUseIndexForSpeed()
IReportOptions
For internal use only.
getEnableUseIndexForSpeed
in interface IReportOptions
public boolean getEnableVerifyOnEveryPrint()
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.
getEnableVerifyOnEveryPrint
in interface IReportOptions
true
if the active database is verified when the report is first refreshed in a session,
and false
otherwise.public java.lang.String getInitialDataContext()
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.
getInitialDataContext
in interface IReportOptions
String
.public java.lang.String getInitialReportPartName()
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.
getInitialReportPartName
in interface IReportOptions
String
.public int getMaxNumOfRecords()
IReportOptions
Returns the maximum number of records the program can use in a report.
getMaxNumOfRecords
in interface IReportOptions
int
.public int getNumOfBrowsingRecords()
IReportOptions
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).
getNumOfBrowsingRecords
in interface IReportOptions
com.crystaldecisions.sdk.occa.report.application.RowsetController
class as an int
.public int getNumOfCachedBatches()
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.
getNumOfCachedBatches
in interface IReportOptions
RowsetCursor
as an int
.public com.crystaldecisions.sdk.occa.report.definition.ReportStyle getReportStyle()
IReportOptions
For internal use only.
getReportStyle
in interface IReportOptions
public int getRowsetBatchSize()
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.
getRowsetBatchSize
in interface IReportOptions
int
. The default value is 100. Specify -1 to retrieve all records in one batch.public boolean getRefreshCEProperties()
IReportOptions
Queries the report to see if the object's settings are updated when saved to BusinessObjects Enterprise.
getRefreshCEProperties
in interface IReportOptions
true
if the ReportOptions
object's settings will
be updated when saved to BusinessObjects Enterprise and false
otherwise.public boolean getErrorOnMaxNumOfRecords()
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.
getErrorOnMaxNumOfRecords
in interface IReportOptions
true
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 IReportOptions
public boolean getConvertOtherNullToDefault()
getConvertOtherNullToDefault
in interface IReportOptions
public boolean getShowAllHeadersOnDrillDown()
getShowAllHeadersOnDrillDown
in interface IReportOptions
public boolean getVerifyStoredProcOnFirstRefresh()
IReportOptions
Returns if refresh stored procedure on first refresh
getVerifyStoredProcOnFirstRefresh
in interface IReportOptions
boolean
. public boolean getRespectKeepGroupTogetherOnFirstPage()
IReportOptions
Returns if respect keep group together on first page
getRespectKeepGroupTogetherOnFirstPage
in interface IReportOptions
boolean
. public boolean getSuppressPrintingIfNoRecords()
IReportOptions
Returns if suppress printing when no records
getSuppressPrintingIfNoRecords
in interface IReportOptions
boolean
. public boolean getCreateGroupTree()
IReportOptions
Returns if create group tree
getCreateGroupTree
in interface IReportOptions
boolean
. public boolean getShowTriggeredAlerts()
public ZoomMode getZoomMode()
IReportOptions
returns the current zoom mode
getZoomMode
in interface IReportOptions
public 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)
For internal use only.
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void setCanSelectDistinctRecords(boolean canSelectDistinctRecords)
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.
setCanSelectDistinctRecords
in interface IReportOptions
canSelectDistinctRecords
- 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)
IReportOptions
For internal use only.
setCanSetTableLocation
in interface IReportOptions
public void setConvertDateTimeType(ConvertDateTimeType convertDateTimeType)
IReportOptions
For internal use only.
setConvertDateTimeType
in interface IReportOptions
public void setEnableAsyncQuery(boolean enableAsyncQuery)
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.
setEnableAsyncQuery
in interface IReportOptions
enableAsyncQuery
- true
if the program uses asynchronous queries, and
false
otherwise.public void setEnablePushDownGroupBy(boolean enablePushDownGroupBy)
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:
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 IReportOptions
enablePushDownGroupBy
- true
to have the program perform grouping on the server
(server-side processing), and false
otherwise.public void setEnableSaveDataWithReport(boolean enableSaveDataWithReport)
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.
setEnableSaveDataWithReport
in interface IReportOptions
enableSaveDataWithReport
- true
to have the current data saved with the report,
and false
otherwise.public void setEnableSaveSummariesWithReport(boolean enableSaveSummariesWithReport)
IReportOptions
For internal use only.
setEnableSaveSummariesWithReport
in interface IReportOptions
public void setEnableSelectDistinctRecords(boolean enableSelectDistinctRecords)
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.
setEnableSelectDistinctRecords
in interface IReportOptions
enableSelectDistinctRecords
- true
if, in the report, only unique records are being selected from the
SQL tables in your database, and false
otherwise.public void setEnableTranslateDOSMemos(boolean enableTranlateDOSMemos)
IReportOptions
For internal use only.
setEnableTranslateDOSMemos
in interface IReportOptions
public void setEnableTranslateDOSStrings(boolean enableTranslateDOSStrings)
IReportOptions
For internal use only.
setEnableTranslateDOSStrings
in interface IReportOptions
public void setEnableUseCaseInsensitiveSQLData(boolean enableUseCaseInsensitiveSQLData)
IReportOptions
For internal use only.
setEnableUseCaseInsensitiveSQLData
in interface IReportOptions
public void setEnableUseDummyData(boolean enableUseDummyData)
IReportOptions
For internal use only.
setEnableUseDummyData
in interface IReportOptions
public void setEnableUseIndexForSpeed(boolean enableUseIndexForSpeed)
IReportOptions
For internal use only.
setEnableUseIndexForSpeed
in interface IReportOptions
public void setEnableVerifyOnEveryPrint(boolean enableVerifyOnEveryPrint)
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.
setEnableVerifyOnEveryPrint
in interface IReportOptions
enableVerifyOnEveryPrint
- 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)
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.
setInitialDataContext
in interface IReportOptions
newInitialDataContext
- The initial data context as a String
.public void setInitialReportPartName(java.lang.String newInitialReportPartName)
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.
setInitialReportPartName
in interface IReportOptions
newInitialReportPartName
- The initial report part name for the report part that is displayed as a String
.public void setMaxNumOfRecords(int maxNumOfRecords)
IReportOptions
Sets the maximum number of records the program can use in a report.
setMaxNumOfRecords
in interface IReportOptions
maxNumOfRecords
- 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 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).
setNumOfBrowsingRecords
in interface IReportOptions
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
.public void setNumOfCachedBatches(int newNumOfCachedBatches)
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.
setNumOfCachedBatches
in interface IReportOptions
newNumOfCachedBatches
- The default number of rowset batches that are cached in the
RowsetCursor
as an int
.@Deprecated public void setReportStyle(com.crystaldecisions.sdk.occa.report.definition.ReportStyle newReportStyle)
IReportOptions
For internal use only.
setReportStyle
in interface IReportOptions
public void setRowsetBatchSize(int newRowsetBatchSize)
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.
setRowsetBatchSize
in interface IReportOptions
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.public void setRefreshCEProperties(boolean refreshCEProperties)
IReportOptions
Sets the value of refreshCEProperties
to true
if the object's settings are updated when saved to BusinessObjects Enterprise and to false
.
setRefreshCEProperties
in interface IReportOptions
refreshCEProperties
- true
if the ReportOptions
object's settings will
be updated when saved to 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 IReportOptions
errorOnMaxNumOfRecords
- 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 IReportOptions
public void setConvertOtherNullToDefault(boolean bConvertOtherNullToDefault)
setConvertOtherNullToDefault
in interface IReportOptions
public void setShowAllHeadersOnDrillDown(boolean bShowAllHeadersOnDrillDown)
setShowAllHeadersOnDrillDown
in interface IReportOptions
public void setVerifyStoredProcOnFirstRefresh(boolean bVerifyStoredProcOnFirstRefresh)
IReportOptions
set value if refresh stored procedure on first refresh
setVerifyStoredProcOnFirstRefresh
in interface IReportOptions
bVerifyStoredProcOnFirstRefresh
- as aboolean
. public void setRespectKeepGroupTogetherOnFirstPage(boolean bRespectKeepGroupTogetherOnFirstPage)
IReportOptions
set value if respect keep group together on first page
setRespectKeepGroupTogetherOnFirstPage
in interface IReportOptions
bRespectKeepGroupTogetherOnFirstPage
- as aboolean
. public void setSuppressPrintingIfNoRecords(boolean bSuppressPrintingIfNoRecords)
IReportOptions
set value if suppress printing when no records
setSuppressPrintingIfNoRecords
in interface IReportOptions
bSuppressPrintingIfNoRecords
- as aboolean
. public void setCreateGroupTree(boolean bCreateGroupTree)
IReportOptions
set value if create group tree
setCreateGroupTree
in interface IReportOptions
bCreateGroupTree
- as aboolean
. public void setShowTriggeredAlerts(boolean bShowTriggeredAlerts)
public void setZoomMode(ZoomMode zoomMode)
IReportOptions
set current zoom mode
setZoomMode
in interface IReportOptions
zoomMode
- new zooom modepublic void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
public ControllableMixin getControllableMixin()
public void doControllerModification(java.lang.Object newObject) throws ReportSDKException
ReportSDKException
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |