com.crystaldecisions.sdk.occa.managedreports
Interface IReportAppFactory


public interface IReportAppFactory

This interface provides a common service point for accessing a ReportClientDocument. A ReportClientDocument object provides methods for modifying a report. To get the IReportAppFactory interface, you must call IEnterpriseSession.getService method as follows:

IReportAppFactory reportAppFactory = (IReportAppFactory) es.getService("","RASReportFactory").

Note: This interface can only be used when the Report Application Server is running as server component within the SAP BusinessObjects Enterprise framework.


Method Summary
 ReportClientDocument newDocument(java.util.Locale productLocale)
           Returns a ReportClientDocument object representing a blank report object.
 ReportClientDocument openDocument(IInfoObject obj, int options, java.util.Locale productLocale)
          Creates a ReportClientDocument object that represents a report.
 ReportClientDocument openDocument(IInfoObject obj, int options, java.util.Locale productLocale, java.util.Locale pvlOverride)
          For internal use only.
 ReportClientDocument openDocument(int objID, int options, java.util.Locale productLocale)
          Deprecated. As of Version 10.
 

Method Detail

openDocument

ReportClientDocument openDocument(int objID,
                                  int options,
                                  java.util.Locale productLocale)
                                  throws SDKException
Deprecated. As of Version 10.

Returns a ReportClientDocument object representing a Report object that is open for modification.

Parameters:
objID - The Id of a report InfoObject.
options - The options for opening a report. See OpenReportOptions.
productLocale - The Locale of the application user interface and error messages. Does not affect the report rendering locale.
Returns:
A ReportClientDocument object.
Throws:
com.crystaldecisions.sdk.exception.SDKException
SDKException

openDocument

ReportClientDocument openDocument(IInfoObject obj,
                                  int options,
                                  java.util.Locale productLocale)
                                  throws SDKException

Creates a ReportClientDocument object that represents a report.

Use this method to open a report when you are using the RAS server to access managed reports in the CMS repository.

Applications using the RAS server to access unmanaged reports from a file path must not use this method to open a report. Instead, use the Open method in the ClientDocument class.

Parameters:
obj - A report IInfoObject.
options - The options for opening a report. See OpenReportOptions.
productLocale - The Locale of the application user interface and error messages. Does not affect the report rendering locale.
Returns:
A ReportClientDocument object.
Throws:
com.crystaldecisions.sdk.exception.SDKException
SDKException

openDocument

ReportClientDocument openDocument(IInfoObject obj,
                                  int options,
                                  java.util.Locale productLocale,
                                  java.util.Locale pvlOverride)
                                  throws SDKException
For internal use only.

Throws:
SDKException

newDocument

ReportClientDocument newDocument(java.util.Locale productLocale)
                                 throws SDKException

Returns a ReportClientDocument object representing a blank report object.

Note: The report object is not created until you add tables to it.

Parameters:
productLocale - The Locale of the application user interface and error messages. Does not affect the report rendering locale.
Returns:
A ReportClientDocument object.
Throws:
com.crystaldecisions.sdk.exception.SDKException
SDKException