|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.application.ReportAppSession
public class ReportAppSession
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.
ReportAppSession object.
This ReportAppSession object is set to connect to an add-in RAS server
that is connected to a Central Management Console. The object can then be passed directly into the
ReportClientDocument object to establish a connection.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 |
|---|
public ReportAppSession()
| Method Detail |
|---|
public java.lang.Object createService(java.lang.String className)
throws java.lang.ClassNotFoundException,
ReportSDKException,
java.lang.IllegalAccessException,
java.lang.InstantiationException
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.
Object corresponding to the specified service.
java.lang.ClassNotFoundException
ReportSDKException
java.lang.IllegalAccessException
java.lang.InstantiationExceptionpublic java.util.Locale getLocale()
Returns the locale (language) used for the RAS SDK object.
Locale object that defines the language settings used for the RAS
SDK.ReportAppSession.setLocale(java.util.Locale)public java.util.Locale getProductLocale()
ReportAppSession.getPreferredViewingLocale()public java.util.Locale getPreferredViewingLocale()
ReportAppSession.getProductLocale()public java.util.TimeZone getTimeZone()
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.
String that specifies the name of the RAS server that is modifying
the open report or that is used to modify the report.ReportAppSession.setReportAppServer(java.lang.String)public ISecurityContext getSecurityContext()
For internal use only.
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.
ReportSDKExceptionpublic void setCommunicationAdapter(ICommunicationAdapter adapter)
For internal use only.
public void setLocale(java.util.Locale locale)
Sets the locale (language) used for the RAS SDK object.
locale - A Locale object that defines the language settings used for the RAS SDK.ReportAppSession.getLocale()public void setProductLocale(java.util.Locale productLocale)
public void setPreferredViewingLocale(java.util.Locale preferredViewingLocale)
public void setTimeZone(java.util.TimeZone timeZone)
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.
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.
ReportSDKExceptionReportAppSession.getReportAppServer()public void setReportEngineTypeValue(int reportEngineTypeValue)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||