jco.client.html

SAP ERP的二次开发

public final java.lang.String <B>getGWHost</B>()</PRE>
<DL>
<DD>Returns the gateway server<DD><DL>
<DT><B>Returns:</B><DD>the gateway server</DL>
</DD>
</DL>
<HR>

<A NAME="getGWServ()"><!-- --></A><H3>
getGWServ</H3>
<PRE>
public final java.lang.String <B>getGWServ</B>()</PRE>
<DL>
<DD>Returns the gateway service<DD><DL>
<DT><B>Returns:</B><DD>the gateway service</DL>
</DD>
</DL>
<HR>

<A NAME="getSystemID()"><!-- --></A><H3>
getSystemID</H3>
<PRE>
public final java.lang.String <B>getSystemID</B>()</PRE>
<DL>
<DD>Returns the SAP system ID<DD><DL>
<DT><B>Returns:</B><DD>the SAP system ID</DL>
</DD>
</DL>
<HR>

<A NAME="getGroup()"><!-- --></A><H3>
getGroup</H3>
<PRE>
public final java.lang.String <B>getGroup</B>()</PRE>
<DL>
<DD>Returns the group of application servers<DD><DL>
<DT><B>Returns:</B><DD>the group of application servers</DL>
</DD>
</DL>
<HR>

<A NAME="getTPName()"><!-- --></A><H3>
getTPName</H3>
<PRE>
public final java.lang.String <B>getTPName</B>()</PRE>
<DL>
<DD>Returns the program ID of an registered JCO compliant server program<DD><DL>
<DT><B>Returns:</B><DD>Program ID of an registered JCO compliant server program</DL>
</DD>
</DL>
<HR>

<A NAME="getURL()"><!-- --></A><H3>
getURL</H3>
<PRE>
public final java.net.URL <B>getURL</B>()</PRE>
<DL>
<DD>Returns the url to the remote system<DD><DL>
<DT><B>Returns:</B><DD>the url to the remote system or <tt>null</tt> if not set or malformed</DL>
</DD>
</DL>
<HR>

<A NAME="getTrace()"><!-- --></A><H3>
getTrace</H3>
<PRE>
public final boolean <B>getTrace</B>()</PRE>
<DL>
<DD>Returns whether trace is enabled or not.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html#getTrace()">getTrace</A></CODE> in class <CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html">JCO.Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><tt>true</tt> if trace is enabled, <tt>false</tt> otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="setTrace(boolean)"><!-- --></A><H3>
setTrace</H3>
<PRE>
public final void <B>setTrace</B>(boolean&nbsp;trace)</PRE>
<DL>
<DD>Enables/disables trace.<br>
   <em>Note:</em>If the connection is already established the method
    will close and reopen the connection. Any states associated with
   the connection might get lost.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html#setTrace(boolean)">setTrace</A></CODE> in class <CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html">JCO.Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>trace</CODE> - if <tt>true</tt> enables the trace and disables it otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="getAbapDebug()"><!-- --></A><H3>
getAbapDebug</H3>
<PRE>
public boolean <B>getAbapDebug</B>()</PRE>
<DL>
<DD>Returns whether debugging is enabled or not.<DD><DL>
<DT><B>Returns:</B><DD><tt>true</tt> if debugging is enabled, <tt>false</tt> otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="setAbapDebug(boolean)"><!-- --></A><H3>
setAbapDebug</H3>
<PRE>
public void <B>setAbapDebug</B>(boolean&nbsp;debug)</PRE>
<DL>
<DD>Enables/disables abap debug.<br>
   <em>Note:</em>If the connection is already established the method
    will close and reopen the connection. Any states associated with
   the connection might get lost.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>debug</CODE> - if <tt>true</tt> enables ABAP debugging, disables it otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="getSapGui()"><!-- --></A><H3>
getSapGui</H3>
<PRE>
public int <B>getSapGui</B>()</PRE>
<DL>
<DD>Returns if a SAP GUI is being used during a call<DD><DL>
<DT><B>Returns:</B><DD><tt>0</tt> if no GUI, <tt>1</tt> if visible GUI,
  and <tt>2</tt> if invisible GUI is being used</DL>
</DD>
</DL>
<HR>

<A NAME="setSapGui(int)"><!-- --></A><H3>
setSapGui</H3>
<PRE>
public void <B>setSapGui</B>(int&nbsp;use_sapgui)</PRE>
<DL>
<DD>Sets the use_sapgui parameter<DD><DL>
<DT><B>Parameters:</B><DD><CODE>use_sapgui</CODE> - 0/1/2: without/with/invisible SAPGUI</DL>
</DD>
</DL>
<HR>

<A NAME="getState()"><!-- --></A><H3>
getState</H3>
<PRE>
public byte <B>getState</B>()</PRE>
<DL>
<DD>Returns the state of the client as a bit vector<DD><DL>
<DT><B>Returns:</B><DD>the state of the client as a bit vector
 <table border=1>
 <tr><th>Flag                  </th><th>Description                                             </th></tr>
 <tr><td>JCO.STATE_DISCONNECTED</td><td>The client is disconnected                              </td></tr>
 <tr><td>JCO.STATE_CONNECTED   </td><td>The client is connected to the remote server            </td></tr>
 <tr><td>JCO.STATE_BUSY        </td><td>The client is currently executing a remote function call</td></tr>
 <tr><td>JCO.STATE_USED        </td><td>A pooled connection has been allocated by a program     </td></tr>
 </table></DL>
</DD>
</DL>
<HR>

<A NAME="getAttributes()"><!-- --></A><H3>
getAttributes</H3>
<PRE>
public final <A HREF="../../../../com/sap/mw/jco/JCO.Attributes.html">JCO.Attributes</A> <B>getAttributes</B>()</PRE>
<DL>
<DD>Returns the attributes object for this connection.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html#getAttributes()">getAttributes</A></CODE> in class <CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html">JCO.Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the attributes object for this connection.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Exception.html">JCO.Exception</A></CODE> - thrown if the attributes could not be retrieved.<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.Attributes.html"><CODE>JCO.Attributes</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getHashKey(boolean)"><!-- --></A><H3>
getHashKey</H3>
<PRE>
public java.lang.String <B>getHashKey</B>(boolean&nbsp;personalized)</PRE>
<DL>
<DD>Returns a hash key for this client connection<DD><DL>
<DT><B>Parameters:</B><DD><CODE>personalized</CODE> - if <tt>true</tt> include the user into the key generation<DT><B>Returns:</B><DD>a hash key for this client connection<DT><B>Since: </B><DD>JCo 2.0</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="isAlive()"><!-- --></A><H3>
isAlive</H3>
<PRE>
public boolean <B>isAlive</B>()</PRE>
<DL>
<DD>Checks whether the connection is still alive<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html#isAlive()">isAlive</A></CODE> in class <CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html">JCO.Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><tt>true</tt> if the connection is alive, <tt>false</tt> otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="connect()"><!-- --></A><H3>
connect</H3>
<PRE>
public void <B>connect</B>()</PRE>
<DL>
<DD>Opens a client connection to the remote system
  using the current connection parameters<DD><DL>
<DT><B>Throws:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Exception.html">JCO.Exception</A></CODE> - if the connection could not be established</DL>
</DD>
</DL>
<HR>

<A NAME="isPooled()"><!-- --></A><H3>
isPooled</H3>
<PRE>
public boolean <B>isPooled</B>()</PRE>
<DL>
<DD>Returns <tt>true</tt> if the client was allocated from an JCO.Pool.
 Otherwise returns <tt>false</tt><DD><DL>
<DT><B>Returns:</B><DD>true if the client was allocated from an JCO.Pool</DL>
</DD>
</DL>
<HR>

<A NAME="disconnect()"><!-- --></A><H3>
disconnect</H3>
<PRE>
public void <B>disconnect</B>()</PRE>
<DL>
<DD>Closes the connection to the remote system.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html#disconnect()">disconnect</A></CODE> in class <CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html">JCO.Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Exception.html">JCO.Exception</A></CODE> - with the error group set to <tt>JCO.Exception.JCO_ERROR_RESOURCE</tt>,
      must be released back to its pool by using </tt>JCO.releaseClient()</tt>.<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.html#releaseClient(com.sap.mw.jco.JCO.Client)"><CODE>JCO.releaseClient(com.sap.mw.jco.JCO.Client)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="abort(java.lang.String)"><!-- --></A><H3>
abort</H3>
<PRE>
public void <B>abort</B>(java.lang.String&nbsp;message)</PRE>
<DL>
<DD>Aborts the connection to the remote system, i.e.
  tries to send a final message to the host before it disconnects.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html#abort(java.lang.String)">abort</A></CODE> in class <CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html">JCO.Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the final message which will be sent to the remote system.</DL>
</DD>
</DL>
<HR>

<A NAME="execute(com.sap.mw.jco.JCO.Function)"><!-- --></A><H3>
execute</H3>
<PRE>
public void <B>execute</B>(<A HREF="../../../../com/sap/mw/jco/JCO.Function.html">JCO.Function</A>&nbsp;function)</PRE>
<DL>