|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.application.ClientDocument
com.crystaldecisions.sdk.occa.report.application.ReportClientDocument
public class ReportClientDocument
This object enables you to perform operations on a report, including
saving, copying, and closing a report. Use this object to modify a report or create one.
For applications that use the RAS server in SAP BusinessObjects Enterprise, create
ReportClientDocument instances by using the IReportAppFactory interface provided by the
SAP BusinessObjects Enterprise Java SDK.
| Field Summary | |
|---|---|
static java.lang.String |
inprocConnectionString
For internal use only. |
| Fields inherited from class com.crystaldecisions.sdk.occa.report.application.ClientDocument |
|---|
URIPROTOCAL_CECUID, URIPROTOCAL_CEIS, URIPROTOCAL_RAS, URIPROTOCAL_RASSDK |
| Constructor Summary | |
|---|---|
ReportClientDocument()
|
|
ReportClientDocument(IEnterprisePlugin plugin)
|
|
| Method Summary | |
|---|---|
void |
checkDatabaseAndUpdate(VerifyDatabaseFeedbacks verifyDatabaseFeedbacks)
For internal use only. |
FormulaErrors |
checkFormula(IFormula formula)
For internal use only. |
FormulaErrors |
checkFormula(IFormula formula,
java.lang.String contextObjectName)
For internal use only. |
FormulaErrors |
checkFormula(IFormula formula,
java.lang.String contextObjectName,
java.lang.String containerCrosstabName)
For internal use only. |
void |
close()
Closes the ReportClientDocument and releases all resources. |
static ReportClientDocument |
createDefault()
For internal use only |
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. |
static ReportClientDocument |
createReport()
For internal use only |
java.lang.String |
displayName()
Returns the title of the document. |
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
IByteArray |
fetchPreviewThumbnail()
For internal use only. |
void |
flushRequests()
For internal use only. |
ExportOptionsList |
getAvailableExportFormats()
For internal use only. |
CustomFunctionController |
getCustomFunctionController()
Returns the CustomFunctionController object which allows you to get and modify a
custom function. |
IDatabase |
getDatabase()
Deprecated. As of Version 10 |
DatabaseController |
getDatabaseController()
Returns the DatabaseController object that is used to add, remove, and modify the
tables that are used as the report's data source. |
DataDefController |
getDataDefController()
Returns the DataDefController object used to modify the report's data
definition. |
IDataDefinition |
getDataDefinition()
Deprecated. As of Version 10 |
PropertyBag |
getDesignerProperties(java.lang.String subreportName)
For internal use only. |
IDocumentSecurityInfo |
getDocumentSecurityInfo()
For internal use only. |
ReportEngineType |
getEngineType()
For internal use only |
FormulaLanguageService |
getFormulaLanguageService()
For internal use only |
java.lang.Object |
getInternal(java.lang.Class internal)
For internal use only. |
java.lang.Object |
getInternal(java.lang.String name,
java.lang.Class internal)
For internal use only. |
IAuditResult |
getLastAuditResult()
For internal use only. |
ReportClientDocument |
getMainReport()
For internal use only. |
PrintOutputController |
getPrintOutputController()
Returns the PrintOutputController object used to export this document to a different format. |
java.lang.String |
getRecordSelectionFormula()
For internal use only |
ReportDefController |
getReportDefController()
Returns the ReportDefController object used to modify the report definition's areas,
sections, and report objects. |
IReportDocument |
getReportDocument()
Returns the IReportDocument object used to retrieve areas, sections, and report
objects in the report. |
IReportOptions |
getReportOptions()
For internal use only. |
IReportSource |
getReportSource()
Returns the ReportSource object used by the Web Report Viewer to display the
contents of the report. |
IReportStatistics |
getReportStatistics()
For internal use only |
IRepositoryLogonInfo |
getRepositoryLogonInfo()
Deprecated. As of Version 10. |
RepositoryService |
getRepositoryService()
For internal use only. |
RowsetController |
getRowsetController()
Returns the RowsetController object used to browse field and table values in
the database that the report is using and to fetch group tree and rowset data. |
java.lang.Object |
getSavedExportOptions(ReportExportFormat exportFormat)
Gets the saved export options of the report for the specified export format. |
PropertyBag |
getSavedExportOptionsEx(java.lang.String canonicalExportFormatId)
For internal use only |
SearchController |
getSearchController()
Returns the SearchController object, which is used for searching. |
SubreportController |
getSubreportController()
Returns the SubreportController object used to determine the names of the
subreports in the report and to modify the subreports' databases. |
java.util.List |
getUnsupportedFeatures()
For internal use only. |
PropertyBag |
getUserSpecificInfoUsage()
For internal use only. |
boolean |
isCachable(int nOptions)
Returns true if this document is cachable, and false otherwise. |
boolean |
isOpen()
Returns true if this document is open, and false otherwise. |
boolean |
isReadOnly()
Returns true if this document is read-only, false otherwise. |
void |
logOffRepository()
For internal use only. |
void |
logOnRepository(java.lang.String repositorySessionString,
java.lang.String serverToken)
For internal use only. |
void |
modifyDesignerProperties(PropertyBag newProperties,
java.lang.String subreportName)
For internal use only. |
void |
modifyReportOptions(IReportOptions reportOptions)
Modifies the report’s behavior and capabilities such as how it should handle server data, dates, queries, printing, viewing, and other such options. |
void |
modifySummaryInfo(ISummaryInfo summaryInfo)
Modifies the report's summary information such as the author's name, comments, keywords, subject, title, and whether or not a preview image is saved. |
boolean |
needMigration()
For internal use only |
void |
open(java.lang.Object documentPath,
int options)
Opens a supported document. |
static ReportClientDocument |
openReport(java.io.File theFile)
For internal use only |
java.lang.String |
path()
Returns the full path of the document. |
void |
playBackRequests(java.lang.String filePath,
java.lang.String logPath)
For internal use only. |
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
readExternal(java.io.ObjectInput in)
Reads the stream written by the writeExternal method to reconstruct the
ReportClientDocument object. |
void |
refreshReportDocument()
For internal use only. |
void |
refreshRepositoryObjects()
For internal use only. |
void |
save()
Saves changes to the current document. |
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 |
saveAs(java.lang.String displayName,
java.lang.Object parentFolderPath,
int options)
Saves the changes to a new report. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveSubreportAsStandAloneReport(java.lang.String subReportName,
java.lang.String displayName,
java.lang.Object parentFolderPath,
int options)
For internal use only |
void |
setLocale(java.util.Locale locale)
Deprecated. |
void |
setPreferredViewingLocale(java.util.Locale preferredViewingLocale)
Sets the preferred viewing locale of the report. |
void |
setProductLocale(java.util.Locale productLocale)
Sets the product locale of the report. |
void |
setPVLOverride(java.util.Locale pvlOverride)
For internal use only |
void |
setRecordSelectionFormula(java.lang.String formulaText)
For internal use only |
void |
setReportOptions(IReportOptions reportOptions)
Deprecated. As of Version 10, should use modifyReportOptions instead. |
void |
setSavedExportOptions(ReportExportFormat exportFormat,
java.lang.Object exportOptions)
Saves the export options for the report for the specified export format. |
void |
setSavedExportOptionsEx(java.lang.String exportFormatID,
PropertyBag exportOptions)
For internal use only |
void |
setSummaryInfo(ISummaryInfo summaryInfo)
Deprecated. As of Version 10, should use modifySummaryInfo instead. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
PropertyBag |
UID()
Returns the properties that uniquely identify this ClientDocument object. |
void |
verifyDatabase()
Checks to ensure that the report is using the most current data scheme from its database. |
void |
writeExternal(java.io.ObjectOutput out)
Writes the ReportClientDocument's contents to a stream to be read back by the
readExternal method. |
| Methods inherited from class com.crystaldecisions.sdk.occa.report.application.ClientDocument |
|---|
addAdvancedClientDocumentEventListener, addClientDocumentEventListener, dispose, getIsModified, getLocale, getPreferredViewingLocale, getProductLocale, getReportAppServer, getReportAppSession, getTimeZone, getUndoManager, initialize, initServerAgent, isReadyToDispose, newDocument, postCloseServerAgent, postCreateServerAgent, preCloseServerAgent, preCreateServerAgent, removeAdvancedClientDocumentEventListener, removeClientDocumentEventListener, setIsModifiedUntilSaved, setReportAppServer, setReportAppSession, setTimeZone, uninitServerAgent |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.crystaldecisions.sdk.occa.report.application.IReportClientDocument |
|---|
getLocale, getPreferredViewingLocale, getProductLocale, getUndoManager |
| Field Detail |
|---|
public static final java.lang.String inprocConnectionString
| Constructor Detail |
|---|
public ReportClientDocument()
public ReportClientDocument(IEnterprisePlugin plugin)
| Method Detail |
|---|
public void open(java.lang.Object documentPath,
int options)
throws ReportSDKException
ClientDocument
Opens a supported document. This method is used in the standalone version of RAS. To open a
report document using the RAS server in the SAP BusinessObjects Enterprise environment,
use the IReportAppFactory interface in the SAP BusinessObjects Enterprise Java SDK.
If you are running the add-in to SAP BusinessObjects Enterprise version of RAS, you must assign a
valid Enterprise session to the EnterpriseSession property of the
ClientDocument object before calling this method. If you are running the
standalone version of the RAS server, create and initialize a ReportAppSession
object and use it to create a ClientDocument object.
If you are using the standalone version, the source of the report document can be one of the following:
"c:\myreports\report.rpt"
to refer to a file on the computer running the RAS server."rassdk://"; for example,
"rassdk://c:/report.rpt". This opens the report on the RAS SDK machine, and
streams the file to the server.If you are using the RAS server add-in for Crystal Enterprise 8.x, the source of the report document can be one of the following:
Note: This method should not be used when you are running RAS server within SAP BusinessObjects Enterprise.
Instead, use the openDocument method in IReportAppFactory.
RAS provides full support for processing extensions. Processing extensions allows you to filter the data that users can see. Because RAS supports processing extensions, you are able to see the same data as if the report was opened through SAP BusinessObjects Enterprise. For information on applying processing extensions to a report, see the SAP BusinessObjects Enterprise Administrator's Guide.
open in class ClientDocumentdocumentPath - A document to be opened. This can be one of the following:
options - Specifies how the file should be opened. For valid options, see
OpenReportOptions.
ReportSDKExceptionpublic static ReportClientDocument createDefault()
public static ReportClientDocument createReport()
throws ReportSDKException
ReportSDKException
public static ReportClientDocument openReport(java.io.File theFile)
throws ReportSDKException
ReportSDKException
public java.lang.String displayName()
throws ReportSDKException
ClientDocumentReturns the title of the document.
displayName in class ClientDocumentString containing the document's title.
ReportSDKException
public void close()
throws ReportSDKException
Closes the ReportClientDocument and releases all resources.
NOTE: This method must be called by the user to release resources used by this object
and to notify the RAS server to close the report behind the ReportClientDocument
instance. If this method is not called, the report on the RAS server will no longer be accessible,
but will remain in memory until it times out.
close in class ClientDocumentReportSDKException
public void flushRequests()
throws ReportSDKException
For internal use only.
ReportSDKException
public CustomFunctionController getCustomFunctionController()
throws ReportSDKException
Returns the CustomFunctionController object which allows you to get and modify a
custom function. You can create custom functions through Crystal Reports and use the
CustomFunctionController object to access and modify them.
getCustomFunctionController in interface IReportClientDocumentCustomFunctionController object used to modify a custom function.
ReportSDKException
public IDatabase getDatabase()
throws ReportSDKException
Returns the IDatabase object which allows you to retrieve the report's database
name, tables, and table links. It also allows you to retrieve a particular field based on a
field ID and table.
Note: To modify the IDatabase objects, use the ReportClientDocument.getDatabaseController()
method.
IDatabase object for this report.
ReportSDKException
public DatabaseController getDatabaseController()
throws ReportSDKException
Returns the DatabaseController object that is used to add, remove, and modify the
tables that are used as the report's data source.
getDatabaseController in interface IReportClientDocumentDatabaseController object used to add, remove, and modify the tables
that are used as the report's data source.
ReportSDKException
public DataDefController getDataDefController()
throws ReportSDKException
Returns the DataDefController object used to modify the report's data
definition.
A data definition defines what data is used in the report and how it is treated. Use the
DataDefController object to modify the report's databases, formula fields, groups,
parameter fields, record filters, and sorting definition.
getDataDefController in interface IReportClientDocumentDataDefController object used to modify the report's data definition.
ReportSDKException
public IDataDefinition getDataDefinition()
throws ReportSDKException
Returns the IDataDefinition object used to access a report's formula fields,
group filters, group name fields, groups, parameter fields, record filters, result fields,
sorting definitions, and summary fields.
Note: This object should be accessed using the DataDefController.getDataDefinition() method.
IDataDefinition object.
ReportSDKExceptionpublic FormulaLanguageService getFormulaLanguageService()
getFormulaLanguageService in interface IReportClientDocumentpublic RepositoryService getRepositoryService()
getRepositoryService in interface IReportClientDocument
public PrintOutputController getPrintOutputController()
throws ReportSDKException
Returns the PrintOutputController object used to export this document to a different format.
getPrintOutputController in interface IReportClientDocumentPrintOutputController object used to export this document to a different format.
ReportSDKException
public ReportDefController getReportDefController()
throws ReportSDKException
Returns the ReportDefController object used to modify the report definition's areas,
sections, and report objects.
getReportDefController in interface IReportClientDocumentReportDefController object.
ReportSDKException
public IReportDocument getReportDocument()
throws ReportSDKException
Returns the IReportDocument object used to retrieve areas, sections, and report
objects in the report. This property provides access to areas in the report; each area may
contain multiple sections, and each section may contain multiple report objects. A new report,
by default, contains five area objects: the Report Header area, the Page Header area, the Details
area, the Report Footer area, and the Page Footer area.
IReportDocument object used to retrieve areas, sections, and report
objects in the report.
ReportSDKExceptionpublic IReportSource getReportSource()
Returns the ReportSource object used by the Web Report Viewer to display the
contents of the report.
IReportSource object used by the viewer to display the report.public IRepositoryLogonInfo getRepositoryLogonInfo()
Returns the IRepositoryLogonInfo object used to get and set the database logon
information for the report.
IRepositoryLogonInfo object used to get and set the database logon
information for the report.
public RowsetController getRowsetController()
throws ReportSDKException
Returns the RowsetController object used to browse field and table values in
the database that the report is using and to fetch group tree and rowset data.
getRowsetController in interface IReportClientDocumentRowsetController object.
ReportSDKException
public SearchController getSearchController()
throws ReportSDKException
Returns the SearchController object, which is used for searching. This
controller is similar to the RowsetController object in that you can retrieve
rowset information in the report. In addition, you can specify a search filter for the
records you are looking for.
getSearchController in interface IReportClientDocumentSearchController object used to perform searches.
ReportSDKException
public SubreportController getSubreportController()
throws ReportSDKException
Returns the SubreportController object used to determine the names of the
subreports in the report and to modify the subreports' databases.
SubreportController object used.
ReportSDKExceptionpublic boolean isCachable(int nOptions)
Returns true if this document is cachable, and false otherwise.
nOptions - An OpenReportOptions constant that specifies the options used
to open this report.
true if this document is cachable, and false otherwise.
public boolean isOpen()
throws ReportSDKException
Returns true if this document is open, and false otherwise.
true if this document is open, and false otherwise.
ReportSDKException
public boolean isReadOnly()
throws ReportSDKException
ClientDocument
Returns true if this document is read-only, false otherwise.
isReadOnly in class ClientDocumenttrue if this document is read-only, false otherwise.
ReportSDKException
public boolean needMigration()
throws ReportSDKException
ReportSDKException
public java.lang.String path()
throws ReportSDKException
ClientDocumentReturns the full path of the document.
path in class ClientDocumentString that specifies the full path of the document.
ReportSDKException
public void playBackRequests(java.lang.String filePath,
java.lang.String logPath)
For internal use only.
public void readExternal(java.io.ObjectInput in)
throws java.io.IOException,
java.lang.ClassNotFoundException
Reads the stream written by the writeExternal method to reconstruct the
ReportClientDocument object. You must first create an instance of the
ReportClientDocument using the public no-arg constructor and then call this
method on this instance to restore its contents.
readExternal in interface java.io.Externalizablein - the input object to be read
java.io.IOException
java.lang.ClassNotFoundException
public void refreshRepositoryObjects()
throws ReportSDKException
For internal use only.
ReportSDKException
public void refreshReportDocument()
throws ReportSDKException
For internal use only.
ReportSDKException
public void save()
throws java.io.IOException,
ReportSDKException
Saves changes to the current document.
If the file cannot be modified, or is marked read-only, the method will fail. Use the
ReportClientDocument.isReadOnly() method to check if the file is read-only or not.
If the report is saved to a SAP BusinessObjects Enterprise system, any existing processing extensions are saved with the report. For information on applying processing extensions to a report, see the SAP BusinessObjects Enterprise Administrator's Guide.
save in class ClientDocumentjava.io.IOException
ReportSDKException
public void saveAs(java.lang.String displayName,
java.lang.Object parentFolderPath,
int options)
throws ReportSDKException,
java.io.IOException
Saves the changes to a new report.
If the report is saved successfully, the ReportClientDocument
points to the newly saved report. The saveAs method fails when:
You can use the ReportClientDocument.isReadOnly() method to determine if the report is read-only.
Integer)See the Report Application Server Java SDK Develoepr Guide for more information about
configuring RAS to work with unmanaged reports.
If the report is saved to SAP BusinessObjects Enterprise, any existing processing extensions are saved with the report. If it is saved to a folder on the RAS server or on RAS SDK machine the processing extensions are not preserved. However, the report's selection formulas are modified to apply the data filtering rules enforced by the processing extensions. For information on applying processing extensions to a report, see the SAP BusinessObjects Enterprise Administrator's Guide.
saveAs in class ClientDocumentdisplayName - The name of the file.parentFolderPath - This parameter specifies a folder where the report is saved.options - Specifies how the file should be saved. If this value is not included,
this method attempts to save the file in the current version without overwriting existing
files. For valid options, see ReportSaveAsOptions.
ReportSDKException
java.io.IOException
public void saveSubreportAsStandAloneReport(java.lang.String subReportName,
java.lang.String displayName,
java.lang.Object parentFolderPath,
int options)
throws ReportSDKException,
java.io.IOException
ReportSDKException
java.io.IOException
public void setLocale(java.util.Locale locale)
throws ReportSDKException
ClientDocumentSets the locale that is used to localize various aspects of the document.
Note: This method is only used in standalone RAS. When you use RAS in SAP BusinessObjects Enterprise,
the locale is set when you
create a a ReportClientDocument using the
IReportAppFactory openDocument method. The locale cannot be set after the
ReportClientDocument has been created.
setLocale in class ClientDocumentlocale - The Locale object used to localize the document.
ReportSDKException
public void setProductLocale(java.util.Locale productLocale)
throws ReportSDKException
ClientDocumentSets the product locale of the report. The product locale is the locale of the user interface (UI) of the components such as the viewers that display the report to the user.
The product locale controls the user interface (UI) for the viewers and related components (parameter prompt dialog box, toolbar, error messages)
when displaying a report to the user. To change the regional formatting of dates, times, and numbers in the report, see the
ClientDocument.setPreferredViewingLocale(java.util.Locale preferredViewingLocale) method.
setProductLocale in class ClientDocumentproductLocale - A java.util.Locale object as the locale.
ReportSDKException
public void setPreferredViewingLocale(java.util.Locale preferredViewingLocale)
throws ReportSDKException
ClientDocumentSets the preferred viewing locale of the report. The preferred viewing locale is the locale that a user would prefer to see data presented in.
The preferred viewing locale controls regional formatting of dates, times, and numbers in the report. To change the locale of the user
interface (UI) for the viewers and related components (parameter prompt dialog, toolbar, error messages) when displaying a report to the user, see
the ClientDocument.setProductLocale(java.util.Locale productLocale) method.
setPreferredViewingLocale in class ClientDocumentpreferredViewingLocale - A java.util.Locale object as the locale.
ReportSDKExceptionpublic IReportOptions getReportOptions()
IReportClientDocument
getReportOptions in interface IReportClientDocument
public void modifyReportOptions(IReportOptions reportOptions)
throws ReportSDKException
Modifies the report’s behavior and capabilities such as how it should handle server data, dates, queries, printing, viewing, and other such options.
Example:
This sample shows how to set the report options. IReportOptions
interface enables you to get and set a number of technical options that apply only to an active report.
IReportDocument reportDocument = clientDoc.getReportDocument();
ReportOptions reportOptions = new ReportOptions(reportDocument.getReportOptions());
reportOptions.setEnableVerifyOnEveryPrint(true);
clientDoc.modifyReportOptions(reportOptions);
modifyReportOptions in interface IReportClientDocumentreportOptions - the IReportOptions object to be modified
ReportSDKException
public void setReportOptions(IReportOptions reportOptions)
throws ReportSDKException
modifyReportOptions instead.
Specifies the report options value.
ReportSDKException
public void modifySummaryInfo(ISummaryInfo summaryInfo)
throws ReportSDKException
Modifies the report's summary information such as the author's name, comments, keywords, subject, title, and whether or not a preview image is saved.
summaryInfo - the ISummaryInfo object to be modified
ReportSDKException
public IByteArray fetchPreviewThumbnail()
throws ReportSDKException
ReportSDKException
public PropertyBag getDesignerProperties(java.lang.String subreportName)
throws ReportSDKException
ReportSDKException
public void modifyDesignerProperties(PropertyBag newProperties,
java.lang.String subreportName)
throws ReportSDKException
ReportSDKException
public void setSummaryInfo(ISummaryInfo summaryInfo)
throws ReportSDKException
modifySummaryInfo instead.
Specifies the summary info value.
ReportSDKException
public IReportStatistics getReportStatistics()
throws ReportSDKException
IReportClientDocument
getReportStatistics in interface IReportClientDocumentReportSDKException
public PropertyBag UID()
throws ReportSDKException
ClientDocument
Returns the properties that uniquely identify this ClientDocument object.
UID in class ClientDocumentPropertyBag containing the properties that uniquely identify this
ClientDocument object.
ReportSDKException
public void verifyDatabase()
throws ReportSDKException
Checks to ensure that the report is using the most current data scheme from its database. If
the scheme of the database on the server have been changed, the report is automatically
updated. If a new field has been added to the database on the server, the new field is added
to the report but will not be displayed in the report's contents. If a field has been deleted
from the database, the field will also be deleted from the report. If the method fails, it
throws a ReportSDKException containing the error code.
verifyDatabase in interface IReportClientDocumentReportSDKException - This is thrown if the report fails to be updated from the
database. The exception will contain the error code given.
public void checkDatabaseAndUpdate(VerifyDatabaseFeedbacks verifyDatabaseFeedbacks)
throws ReportSDKException
checkDatabaseAndUpdate in interface IReportClientDocumentReportSDKException
public void writeExternal(java.io.ObjectOutput out)
throws java.io.IOException
Writes the ReportClientDocument's contents to a stream to be read back by the
readExternal method.
writeExternal in interface java.io.Externalizableout - the input object to be written out to the stream
java.io.IOException
public FormulaErrors checkFormula(IFormula formula)
throws ReportSDKException
checkFormula in interface IReportClientDocumentReportSDKException
public FormulaErrors checkFormula(IFormula formula,
java.lang.String contextObjectName)
throws ReportSDKException
checkFormula in interface IReportClientDocumentReportSDKException
public FormulaErrors checkFormula(IFormula formula,
java.lang.String contextObjectName,
java.lang.String containerCrosstabName)
throws ReportSDKException
checkFormula in interface IReportClientDocumentReportSDKException
public java.util.List getUnsupportedFeatures()
throws ReportSDKException
ReportSDKException
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 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.IOException
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
public void setSavedExportOptions(ReportExportFormat exportFormat,
java.lang.Object exportOptions)
throws ReportSDKException
Saves the export options for the report for the specified export format. The supported formats for saved export options are PDF, Microsoft Excel (97-2003) Data-Only, Microsoft Excel (97-2003) (page-based), Separated Values (CSV), Microsoft Word - Editable (RTF), and Text.
exportFormat - the ReportExportFormat object that specifies the export format of a reportexportOptions - the export options of the report for the specified export format
ReportSDKException
public void setSavedExportOptionsEx(java.lang.String exportFormatID,
PropertyBag exportOptions)
throws ReportSDKException
ReportSDKException
public PropertyBag getSavedExportOptionsEx(java.lang.String canonicalExportFormatId)
throws ReportSDKException
ReportSDKException
public java.lang.Object getSavedExportOptions(ReportExportFormat exportFormat)
throws ReportSDKException
Gets the saved export options of the report for the specified export format. The supported formats for saved export options are PDF, Microsoft Excel (97-2003) Data-Only, Microsoft Excel (97-2003) (page-based), Separated Values (CSV), Microsoft Word - Editable (RTF), and Text.
exportFormat - the ReportExportFormat object that specifies the export format of a report
ReportSDKException
public java.lang.String getRecordSelectionFormula()
throws ReportSDKException
IReportClientDocument
getRecordSelectionFormula in interface IReportClientDocumentReportSDKException
public void setRecordSelectionFormula(java.lang.String formulaText)
throws ReportSDKException
IReportClientDocument
setRecordSelectionFormula in interface IReportClientDocumentReportSDKExceptionpublic ReportClientDocument getMainReport()
IReportClientDocument
getMainReport in interface IReportClientDocumentpublic java.lang.Object getInternal(java.lang.Class internal)
public java.lang.Object getInternal(java.lang.String name,
java.lang.Class internal)
public void logOnRepository(java.lang.String repositorySessionString,
java.lang.String serverToken)
throws ReportSDKException
ReportSDKException
public void logOffRepository()
throws ReportSDKException
ReportSDKException
public IDocumentSecurityInfo getDocumentSecurityInfo()
throws ReportSDKException
ReportSDKException
public PropertyBag getUserSpecificInfoUsage()
throws ReportSDKException
ReportSDKException
public ExportOptionsList getAvailableExportFormats()
throws ReportSDKException
ReportSDKExceptionpublic ReportEngineType getEngineType()
public void setPVLOverride(java.util.Locale pvlOverride)
public IAuditResult getLastAuditResult()
throws ReportSDKException
getLastAuditResult in interface IReportClientDocumentReportSDKException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||