com.crystaldecisions.sdk.occa.report.application
Class ReportAppSession

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.application.ReportAppSession

public class ReportAppSession
extends java.lang.Object

Use the ReportAppSession class to establish a connection to a specific RAS server. This class should only be used with the standalone version of RAS, where there is only one RAS server on the network. In SAP BusinessObjects Enterprise, however, you can have several RAS servers and server groups. In this scenario, you should not use the ReportAppSession to establish a connection with a specific RAS server. For RAS connection setup in SAP BusinessObjects Enterprise, see the IReportAppFactory class.

The ReportAppSession object allows you to specify the name of the RAS server, and determine the locale. Use the initialize method to begin a session with the RAS server and the createService to create a ReportClientDocument object that allows you to open and modify reports.

To establish a connection to a RAS server

  1. Set a new ReportAppSession.
  2. You can establish a connection in one of two ways:
  3. Use Initialize to begin session.
  4. Use createService to enable your SDK object to communicate with the RAS server.


Constructor Summary
ReportAppSession()
           
 
Method Summary
 java.lang.Object createService(java.lang.String className)
          
 java.util.Locale getLocale()
          Deprecated.  
 java.util.Locale getPreferredViewingLocale()
          Returns the locale used to render the report.
 java.util.Locale getProductLocale()
          Returns the locale of application user interface and error messages.
 java.lang.String getReportAppServer()
           Returns the name of the RAS server that is modifying the open report or that is used to modify the report.
 ISecurityContext getSecurityContext()
           For internal use only.
 java.util.TimeZone getTimeZone()
           
 void initialize()
           Establishes a connection to the RAS server.
 void setCommunicationAdapter(ICommunicationAdapter adapter)
           For internal use only.
 void setLocale(java.util.Locale locale)
          Deprecated.  
 void setPreferredViewingLocale(java.util.Locale preferredViewingLocale)
           
 void setProductLocale(java.util.Locale productLocale)
           
 void setReportAppServer(java.lang.String reportAppServer)
           Sets the name of the RAS server that is modifying the open report or that is used to modify the report.
 void setReportEngineTypeValue(int reportEngineTypeValue)
           
 void setTimeZone(java.util.TimeZone timeZone)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportAppSession

public ReportAppSession()
Method Detail

createService

public java.lang.Object createService(java.lang.String className)
                               throws java.lang.ClassNotFoundException,
                                      ReportSDKException,
                                      java.lang.IllegalAccessException,
                                      java.lang.InstantiationException

Parameters:
className - The programmatic identifier of the object. This value is the fully qualified class name of the desired service. This can be either com.crystaldecisions.sdk.occa.report.application.ReportClientDocument or com.crystaldecisions.sdk.occa.report.application.ConnectionDirManager.
Returns:
An Object corresponding to the specified service.
Throws:
java.lang.ClassNotFoundException
ReportSDKException
java.lang.IllegalAccessException
java.lang.InstantiationException

getLocale

public java.util.Locale getLocale()
Deprecated. 

Returns the locale (language) used for the RAS SDK object.

Returns:
A Locale object that defines the language settings used for the RAS SDK.
See Also:
ReportAppSession.setLocale(java.util.Locale)

getProductLocale

public java.util.Locale getProductLocale()
Returns the locale of application user interface and error messages.

Returns:
java.util.Locale the locale of the application user interface and error messages.
See Also:
ReportAppSession.getPreferredViewingLocale()

getPreferredViewingLocale

public java.util.Locale getPreferredViewingLocale()
Returns the locale used to render the report.

Returns:
java.util.Locale the locale used to render the report.
See Also:
ReportAppSession.getProductLocale()

getTimeZone

public java.util.TimeZone getTimeZone()

getReportAppServer

public java.lang.String getReportAppServer()

Returns the name of the RAS server that is modifying the open report or that is used to modify the report. This is also used by the ConnectionDirManager object to get directory items.

Once you specify which RAS server you wish to connect to, use the ReportAppSession.initialize() method to establish your connection.

Returns:
A String that specifies the name of the RAS server that is modifying the open report or that is used to modify the report.
See Also:
ReportAppSession.setReportAppServer(java.lang.String)

getSecurityContext

public ISecurityContext getSecurityContext()

For internal use only.


initialize

public void initialize()
                throws ReportSDKException

Establishes a connection to the RAS server. Once a connection is established, for that session, you cannot establish a connection with a different RAS server unless you create a new ReportAppSession object.

Throws:
ReportSDKException

setCommunicationAdapter

public void setCommunicationAdapter(ICommunicationAdapter adapter)

For internal use only.


setLocale

public void setLocale(java.util.Locale locale)
Deprecated. 

Sets the locale (language) used for the RAS SDK object.

Parameters:
locale - A Locale object that defines the language settings used for the RAS SDK.
See Also:
ReportAppSession.getLocale()

setProductLocale

public void setProductLocale(java.util.Locale productLocale)

setPreferredViewingLocale

public void setPreferredViewingLocale(java.util.Locale preferredViewingLocale)

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)

setReportAppServer

public void setReportAppServer(java.lang.String reportAppServer)
                        throws ReportSDKException

Sets the name of the RAS server that is modifying the open report or that is used to modify the report. This is also used by the ConnectionDirManager object to get directory items.

Once you specify which RAS server you wish to connect to, use the ReportAppSession.initialize() method to establish your connection.

Parameters:
reportAppServer - A String that specifies the name of the RAS server that is modifying the open report or that is used to modify the report.
Throws:
ReportSDKException
See Also:
ReportAppSession.getReportAppServer()

setReportEngineTypeValue

public void setReportEngineTypeValue(int reportEngineTypeValue)