Edit D:\app\Administrator\product\11.2.0\dbhome_1\olap\api\doc\oracle\olapi\session\UserSession.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
UserSession (Oracle OLAP Java API Reference)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="UserSession (Oracle OLAP Java API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Oracle&reg; OLAP Java API Reference 11g Release 2 (11.2) E10794-01 Beta Draft
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;PREV CLASS&nbsp;
&nbsp;NEXT CLASS</TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../index.html?oracle/olapi/session/UserSession.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="UserSession.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

oracle.olapi.session
 
Class UserSession</H2>
<PRE>
java.lang.Object
 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">oracle.olapi.session.UserSession
</PRE>
<HR>
<DL>
<DT><PRE>public class UserSession<DT>extends java.lang.Object</DL>
</PRE>

Associates a <CODE>DataProvider</CODE> with an <CODE>OracleConnection</CODE>.
 An application creates a <CODE>UserSession</CODE> with the 
 <CODE>createSession</CODE> method of a <CODE>DataProvider</CODE>.

An application can have many <CODE>UserSession</CODE> objects that share the 
 same <CODE>DataProvider</CODE>.
 Each <CODE>UserSession</CODE> has a separate <CODE>OracleConnection</CODE>.
 The metadata provided by the <CODE>DataProvider</CODE> is the same for all of
 the <CODE>UserSession</CODE> objects.

To end a <CODE>UserSession</CODE>, an application calls the
 <CODE>closeSession</CODE> method of the <CODE>UserSession</CODE>.
 Doing so closes any open <CODE>CursorManager</CODE> objects and commits or 
 rolls back any <CODE>Transaction</CODE> objects associated with the 
 <CODE>UserSession</CODE>.
 It does not, however, close the associated <CODE>OracleConnection</CODE>.

<HR>

<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/session/UserSession.html#closeSession()">closeSession</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the <code>UserSession</code> but does not close the associated
 <CODE>OracleConnection</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;oracle.jdbc.OracleConnection</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/session/UserSession.html#getConnection()">getConnection</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <CODE>OracleConnection</CODE> associated with the 
 <CODE>UserSession</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../oracle/olapi/data/source/DataProvider.html" title="class in oracle.olapi.data.source">DataProvider</A></CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/session/UserSession.html#getDataProvider()">getDataProvider</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <CODE>DataProvider</CODE> associated with the 
 <CODE>UserSession</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/session/UserSession.html#getDefaultLanguage()">getDefaultLanguage</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the default language for the <CODE>UserSession</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../oracle/olapi/transaction/Transaction.html" title="interface in oracle.olapi.transaction">Transaction</A></CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/session/UserSession.html#getRootTransaction()">getRootTransaction</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the root <CODE>Transaction</CODE> associated with the
 <CODE>UserSession</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../oracle/olapi/metadata/XMLParserCallback.html" title="interface in oracle.olapi.metadata">XMLParserCallback</A></CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/session/UserSession.html#getServerXMLParserCallback()">getServerXMLParserCallback</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <CODE>XMLParserCallback</CODE> implementation that is 
 associated with this <CODE>UserSession</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.util.Properties</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/session/UserSession.html#getSettings()">getSettings</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the <code>Properties</code> object that contains all of the settings
 used by this <code>UserSession</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/session/UserSession.html#interrupt()">interrupt</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Terminates any operation that is currently executing in the
 <CODE>UserSession</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/session/UserSession.html#isOpen()">isOpen</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether the <CODE>OracleConnection</CODE> has an open 
 connection to the database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/session/UserSession.html#setServerXMLParserCallback(oracle.olapi.metadata.XMLParserCallback)">setServerXMLParserCallback</A>(<A HREF="../../../oracle/olapi/metadata/XMLParserCallback.html" title="interface in oracle.olapi.metadata">XMLParserCallback</A>&nbsp;callback)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies an <CODE>XMLParserCallback</CODE> for Oracle OLAP to use
 when it retrieves a metadata object that is stored on the server.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left">Methods inherited from class java.lang.Object</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;

<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="getRootTransaction()"></A><H3>
getRootTransaction</H3>
<PRE>
public <A HREF="../../../oracle/olapi/transaction/Transaction.html" title="interface in oracle.olapi.transaction">Transaction</A> getRootTransaction()</PRE>
<DL>
<DD>Gets the root <CODE>Transaction</CODE> associated with the
 <CODE>UserSession</CODE>.

<DD><DL>

<DT>Returns:<DD>The root <CODE>Transaction</CODE> associated with the 
 <CODE>UserSession</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="getConnection()"></A><H3>
getConnection</H3>
<PRE>
public oracle.jdbc.OracleConnection getConnection()</PRE>
<DL>
<DD>Gets the <CODE>OracleConnection</CODE> associated with the 
 <CODE>UserSession</CODE>.

<DD><DL>

<DT>Returns:<DD>The root <CODE>OracleConnection</CODE> associated with the 
 <CODE>UserSession</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="isOpen()"></A><H3>
isOpen</H3>
<PRE>
public boolean isOpen()</PRE>
<DL>
<DD>Indicates whether the <CODE>OracleConnection</CODE> has an open 
 connection to the database.

<DD><DL>

<DT>Returns:<DD>A <CODE>boolean</CODE> that is <CODE>true</CODE> if the 
 <CODE>OracleConnection</CODE> is open or <CODE>false</CODE> 
 if it is not.</DL>
</DD>
</DL>
<HR>

<A NAME="closeSession()"></A><H3>
closeSession</H3>
<PRE>
public void closeSession()</PRE>
<DL>
<DD>Closes the <code>UserSession</code> but does not close the associated
 <CODE>OracleConnection</CODE>.

<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getDataProvider()"></A><H3>
getDataProvider</H3>
<PRE>
public <A HREF="../../../oracle/olapi/data/source/DataProvider.html" title="class in oracle.olapi.data.source">DataProvider</A> getDataProvider()</PRE>
<DL>
<DD>Gets the <CODE>DataProvider</CODE> associated with the 
 <CODE>UserSession</CODE>.

<DD><DL>

<DT>Returns:<DD>The <CODE>DataProvider</CODE> associated with the
 <CODE>UserSession</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="getSettings()"></A><H3>
getSettings</H3>
<PRE>
public java.util.Properties getSettings()</PRE>
<DL>
<DD>Get the <code>Properties</code> object that contains all of the settings
 used by this <code>UserSession</code>.

<DD><DL>

<DT>Returns:<DD>A <CODE>Properties</CODE> object that contains the settings
 used by this <code>UserSession</code>.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultLanguage()"></A><H3>
getDefaultLanguage</H3>
<PRE>
public final java.lang.String getDefaultLanguage()</PRE>
<DL>
<DD>Gets the default language for the <CODE>UserSession</CODE>.

<DD><DL>

<DT>Returns:<DD>A <CODE>String</CODE> that identifies the default language for
 the session.</DL>
</DD>
</DL>
<HR>

<A NAME="setServerXMLParserCallback(oracle.olapi.metadata.XMLParserCallback)"></A><H3>
setServerXMLParserCallback</H3>
<PRE>
public void setServerXMLParserCallback(<A HREF="../../../oracle/olapi/metadata/XMLParserCallback.html" title="interface in oracle.olapi.metadata">XMLParserCallback</A>&nbsp;callback)</PRE>
<DL>
<DD>Specifies an <CODE>XMLParserCallback</CODE> for Oracle OLAP to use
 when it retrieves a metadata object that is stored on the server.
 For example, if an application specifies an
 <CODE>XMLParserCallback</CODE> with this method and then calls a
 method like <CODE>MdmMetadataProvider.getMetadataObject(id)</CODE> 
 or <CODE>MdmDatabaseSchema.getTopLevelObject(name)</CODE> and
 the requested object is invalid, then Oracle OLAP calls a method of
 the <CODE>XMLParserCallback</CODE>.
 A object stored on the server can become invalid if, for example,
 the column or table that the object references no longer exists in 
 the database.

The <CODE>XMLParserCallback.ERROR_BY_EXCEPTION</CODE> constant is not
 used by Oracle OLAP for an <CODE>XMLParserCallback</CODE> specified 
 by this method.
 If a method of the <CODE>XMLParserCallback</CODE> returns the
 <CODE>ERROR_BY_EXCEPTION</CODE> constant, then Oracle OLAP uses the
 default constant, which is <CODE>ERROR_BY_SET_TO_NULL</CODE>.

The <CODE>XMLParserCallback</CODE> specified by this method is not
 used by the <CODE>MdmMetadataProvider.importXML</CODE> or the
 <CODE>SyntaxObject.fromSyntax</CODE> methods.
 Those methods use the <CODE>XMLParserCallback</CODE> that the 
 application passes to them.

<DD><DL>
<DT>Parameters:<DD><CODE>callback</CODE> - An implementation of the <CODE>XMLParserCallback</CODE>
 interface.</DL>
</DD>
</DL>
<HR>

<A NAME="getServerXMLParserCallback()"></A><H3>
getServerXMLParserCallback</H3>
<PRE>
public <A HREF="../../../oracle/olapi/metadata/XMLParserCallback.html" title="interface in oracle.olapi.metadata">XMLParserCallback</A> getServerXMLParserCallback()</PRE>
<DL>
<DD>Gets the <CODE>XMLParserCallback</CODE> implementation that is 
 associated with this <CODE>UserSession</CODE>.

<DD><DL>

<DT>Returns:<DD>The <CODE>XMLParserCallback</CODE> associated with this 
 <CODE>UserSession</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="interrupt()"></A><H3>
interrupt</H3>
<PRE>
public final void interrupt()</PRE>
<DL>
<DD>Terminates any operation that is currently executing in the
 <CODE>UserSession</CODE>.
 This method has the same effect as calling the 
 <CODE>oracle.jdbc.OracleConnection.cancel</CODE> method.
 
 An application must call this method in a separate thread.
 An application can use this method to terminate a build operation
 that was initiated by a <CODE>DataProvider.executeBuild</CODE> method.

<DD><DL>
</DL>
</DD>
</DL>

<HR>

<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
<center>Copyright &copy; 2002, 2009, Oracle. All rights reserved.</center>
</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>

</BODY>
</HTML>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de