jco.html

jco book to connect java with SAP

<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoRecordMetaData.html" title="interface in com.sap.conn.jco">JCoRecordMetaData</A> <B>createRecordMetaData</B>(<A HREF="../../../../com/sap/conn/jco/JCoRecordMetaData.html" title="interface in com.sap.conn.jco">JCoRecordMetaData</A>&nbsp;metaData)</PRE>
<DL>
<DD>Returns a newly created instance of JCoRecordMetaData, which is initially
 a copy of the passed JCoRecordMetaData. Use this factory method in 
 order to create similar metadata objects to minimize the code.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>metaData</CODE> - the JCoRecordMetaData object to copy from
<DT><B>Returns:</B><DD>a newly created JCoRecordMetaData</DL>
</DD>
</DL>
<HR>

<A NAME="createListMetaData(java.lang.String)"><!-- --></A><H3>
createListMetaData</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A> <B>createListMetaData</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Returns a newly created and empty instance of JCoListMetaData.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the list metadata.
<DT><B>Returns:</B><DD>a newly created JCoListMetaData</DL>
</DD>
</DL>
<HR>

<A NAME="createListMetaData(java.lang.String, int)"><!-- --></A><H3>
createListMetaData</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A> <B>createListMetaData</B>(java.lang.String&nbsp;name,
                                                 int&nbsp;capacity)</PRE>
<DL>
<DD>Returns a newly created and empty instance of JCoListMetaData
 with the passed initial capacity for new field information. This
 factory method should be used, if you know how many fields the
 record metadata will have to avoid incremental adjustments of the 
 internal data containers.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the list metadata.<DD><CODE>capacity</CODE> - The initial capacity for this metadata object.
<DT><B>Returns:</B><DD>a newly created JCoListMetaData</DL>
</DD>
</DL>
<HR>

<A NAME="createListMetaData(com.sap.conn.jco.JCoListMetaData)"><!-- --></A><H3>
createListMetaData</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A> <B>createListMetaData</B>(<A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A>&nbsp;metaData)</PRE>
<DL>
<DD>Returns a newly created instance of JCoListMetaData, which is initially
 a copy of the passed JCoListMetaData. Use this factory method in 
 order to create similar metadata objects to minimize the code.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>metaData</CODE> - the JCoListMetaData object to copy from
<DT><B>Returns:</B><DD>a newly created JCoListMetaData</DL>
</DD>
</DL>
<HR>

<A NAME="createFunctionTemplate(java.lang.String, com.sap.conn.jco.JCoListMetaData, com.sap.conn.jco.JCoListMetaData, com.sap.conn.jco.JCoListMetaData, com.sap.conn.jco.JCoListMetaData, com.sap.conn.jco.AbapException[])"><!-- --></A><H3>
createFunctionTemplate</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoFunctionTemplate.html" title="interface in com.sap.conn.jco">JCoFunctionTemplate</A> <B>createFunctionTemplate</B>(java.lang.String&nbsp;name,
                                                         <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A>&nbsp;imports,
                                                         <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A>&nbsp;exports,
                                                         <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A>&nbsp;changing,
                                                         <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A>&nbsp;tables,
                                                         <A HREF="../../../../com/sap/conn/jco/AbapException.html" title="class in com.sap.conn.jco">AbapException</A>[]&nbsp;exceptions)</PRE>
<DL>
<DD>This factory method allows to create a JCoFunctionTemplate that can be used 
 in later function module executions. It is normally only used for hardcoded
 repositories or if you provide your own JCoRepository that uses a different
 location for the metadata. 
 The metadata objects used here for the parameter lists have to be locked before
 to avoid inconsistencies.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the function module which is represented by the function template definition<DD><CODE>imports</CODE> - the metadata for all import parameters of the represented function module<DD><CODE>exports</CODE> - the metadata for all export parameters of the represented function module<DD><CODE>changing</CODE> - the metadata for all changing parameters of the represented function module<DD><CODE>tables</CODE> - the metadata for all table parameters of the represented function module<DD><CODE>exceptions</CODE> - array of AbapExceptions, that belong to the represented function module
<DT><B>Returns:</B><DD>a new instance of a JCoFunctionTemplate that consists of the passed metadata
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - in case a metadata object passed as parameter is not locked.</DL>
</DD>
</DL>
<HR>

<A NAME="createFunctionTemplate(java.lang.String, com.sap.conn.jco.JCoListMetaData, com.sap.conn.jco.JCoListMetaData, com.sap.conn.jco.JCoListMetaData, com.sap.conn.jco.JCoListMetaData, com.sap.conn.jco.AbapException[], boolean)"><!-- --></A><H3>
createFunctionTemplate</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoFunctionTemplate.html" title="interface in com.sap.conn.jco">JCoFunctionTemplate</A> <B>createFunctionTemplate</B>(java.lang.String&nbsp;name,
                                                         <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A>&nbsp;imports,
                                                         <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A>&nbsp;exports,
                                                         <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A>&nbsp;changing,
                                                         <A HREF="../../../../com/sap/conn/jco/JCoListMetaData.html" title="interface in com.sap.conn.jco">JCoListMetaData</A>&nbsp;tables,
                                                         <A HREF="../../../../com/sap/conn/jco/AbapException.html" title="class in com.sap.conn.jco">AbapException</A>[]&nbsp;exceptions,
                                                         boolean&nbsp;supportsASXML)</PRE>
<DL>
<DD>This factory method allows to create a JCoFunctionTemplate that can be used 
 in later function module executions. It is normally only used for hardcoded
 repositories or if you provide your own JCoRepository that uses a different
 location for the metadata. 
 The metadata objects used here for the parameter lists have to be locked before
 to avoid inconsistencies.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the function module which is represented by the function template definition<DD><CODE>imports</CODE> - the metadata for all import parameters of the represented function module<DD><CODE>exports</CODE> - the metadata for all export parameters of the represented function module<DD><CODE>changing</CODE> - the metadata for all changing parameters of the represented function module<DD><CODE>tables</CODE> - the metadata for all table parameters of the represented function module<DD><CODE>exceptions</CODE> - array of AbapExceptions, that belong to the represented function module<DD><CODE>supportsASXML</CODE> - flag indicating whether this function module supports the ASXML semantics for serialization in the RFC protocol
<DT><B>Returns:</B><DD>a new instance of a JCoFunctionTemplate that consists of the passed metadata
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - in case a metadata object passed as parameter is not locked.</DL>
</DD>
</DL>
<HR>

<A NAME="createStructure(com.sap.conn.jco.JCoRecordMetaData)"><!-- --></A><H3>
createStructure</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoStructure.html" title="interface in com.sap.conn.jco">JCoStructure</A> <B>createStructure</B>(<A HREF="../../../../com/sap/conn/jco/JCoRecordMetaData.html" title="interface in com.sap.conn.jco">JCoRecordMetaData</A>&nbsp;metaData)</PRE>
<DL>
<DD>Returns a newly created instance of JCoStructure with the passed metadata
 information. The metadata object has to be locked to prevent changes on
 it and thus inconsistencies in the structure.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>metaData</CODE> - the metadata instance.
<DT><B>Returns:</B><DD>a newly created JCoStructure
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if metaData is null or is not locked</DL>
</DD>
</DL>
<HR>

<A NAME="createStructure(com.sap.conn.jco.JCoTable, int)"><!-- --></A><H3>
createStructure</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoStructure.html" title="interface in com.sap.conn.jco">JCoStructure</A> <B>createStructure</B>(<A HREF="../../../../com/sap/conn/jco/JCoTable.html" title="interface in com.sap.conn.jco">JCoTable</A>&nbsp;table,
                                           int&nbsp;row)</PRE>
<DL>
<DD>Returns a newly created instance of JCoStructure with the metadata
 used for the given table instance. The structure values are copied from
 the table line with the given row index.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>table</CODE> - the table is being used as template for the structure.<DD><CODE>row</CODE> - the table line index used to copy the values.
<DT><B>Returns:</B><DD>a newly created JCoStructure
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - row is out of bounds or table is null</DL>
</DD>
</DL>
<HR>

<A NAME="createTable(com.sap.conn.jco.JCoRecordMetaData)"><!-- --></A><H3>
createTable</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoTable.html" title="interface in com.sap.conn.jco">JCoTable</A> <B>createTable</B>(<A HREF="../../../../com/sap/conn/jco/JCoRecordMetaData.html" title="interface in com.sap.conn.jco">JCoRecordMetaData</A>&nbsp;metaData)</PRE>
<DL>
<DD>Returns a newly created instance of JCoTable with the passed metadata
 information. The metadata object has to be locked to prevent changes on
 it and thus inconsistencies in the table.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>metaData</CODE> - the metadata instance.
<DT><B>Returns:</B><DD>a newly created JCoTable
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if metaData is null or is not locked</DL>
</DD>
</DL>
<HR>

<A NAME="getRepositoryIDs()"><!-- --></A><H3>
getRepositoryIDs</H3>
<PRE>
public static java.util.List&lt;java.lang.String&gt; <B>getRepositoryIDs</B>()</PRE>
<DL>
<DD>Returns a list containing IDs of all internally held repository instances
<P>
<DD><DL>

<DT><B>Returns:</B><DD>list of repository IDs</DL>
</DD>
</DL>
<HR>

<A NAME="getRepository(java.lang.String)"><!-- --></A><H3>
getRepository</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoRepository.html" title="interface in com.sap.conn.jco">JCoRepository</A> <B>getRepository</B>(java.lang.String&nbsp;repositoryID)
                                   throws <A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></PRE>
<DL>
<DD>Returns the repository instance corresponding to the given repository ID or null if
 the repository isn't available
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>repositoryID</CODE> - ID of the requested repository
<DT><B>Returns:</B><DD>the repository instance or null
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - if an internal exception occurs, e.g. repositoryID is null</DL>
</DD>
</DL>
<HR>

<A NAME="getDestinationIDs()"><!-- --></A><H3>
getDestinationIDs</H3>
<PRE>
public static java.util.List&lt;java.lang.String&gt; <B>getDestinationIDs</B>()</PRE>
<DL>
<DD>Returns the list containing IDs of all available destinations inclusive JCoCustomDestination
 The IDs returned by this API can be used to obtain a destination
 monitor for a destination.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a list containing IDs of JCoDestination<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/JCo.html#getCustomDestinationIDs(java.lang.String)"><CODE>getCustomDestinationIDs(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getCustomDestinationIDs(java.lang.String)"><!-- --></A><H3>
getCustomDestinationIDs</H3>
<PRE>
public static java.util.List&lt;java.lang.String&gt; <B>getCustomDestinationIDs</B>(java.lang.String&nbsp;destinationID)
                                                                throws <A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></PRE>
<DL>
<DD>Returns the list containing IDs of the custom destination, created from the destination
 with the destinationID. The IDs returned by this API can be used to obtain a destination
 monitor for a custom destination.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a list containing IDs of JCoCustomDestination
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/JCo.html#getCustomDestinationIDs(java.lang.String)"><CODE>getCustomDestinationIDs(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getRepositoryDestinationID(java.lang.String)"><!-- --></A><H3>
getRepositoryDestinationID</H3>
<PRE>
public static java.lang.String <B>getRepositoryDestinationID</B>(java.lang.String&nbsp;destinationID)
                                                   throws <A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></PRE>
<DL>
<DD>Returns the destination ID used by the repository instance internally. In case the destination
 does not instantiate its own and uses the repository from an other destination, null is returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>destinationID</CODE> - of the destination
<DT><B>Returns:</B><DD>destination id or null
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - is thrown if destination id null or the destination id does not exists</DL>
</DD>
</DL>
<HR>

<A NAME="getDestinationMonitor(java.lang.String)"><!-- --></A><H3>
getDestinationMonitor</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/monitor/JCoDestinationMonitor.html" title="interface in com.sap.conn.jco.monitor">JCoDestinationMonitor</A> <B>getDestinationMonitor</B>(java.lang.String&nbsp;destinationID)
                                                   throws <A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></PRE>
<DL>
<DD>Returns the destination monitor for the given destination ID
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>destinationID</CODE> - the destination ID for which the monitor should be returned
<DT><B>Returns:</B><DD>the destination monitor for the destination
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - if something goes wrong</DL>
</DD>
</DL>
<HR>

<A NAME="getServerIDs()"><!-- --></A><H3>
getServerIDs</H3>