jcorepository.html

jco book to connect java with SAP

<A NAME="getStructureDefinition(java.lang.String)"><!-- --></A><H3>
getStructureDefinition</H3>
<PRE>
<A HREF="../../../../com/sap/conn/jco/JCoRecordMetaData.html" title="interface in com.sap.conn.jco">JCoRecordMetaData</A> <B>getStructureDefinition</B>(java.lang.String&nbsp;structureName)
                                         throws <A HREF="../../../../com/sap/conn/jco/JCoException.html" title="class in com.sap.conn.jco">JCoException</A></PRE>
<DL>
<DD>Returns the meta data for the passed structure/table name
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>structureName</CODE> - the name of the structure or table for which the meta data
  is being returned
<DT><B>Returns:</B><DD>the meta data for the given name or <tt>null</tt> if the structure couldn't be found
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoException.html" title="class in com.sap.conn.jco">JCoException</A></CODE> - if an error occurred during the retrieval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              of the data structure definition.</DL>
</DD>
</DL>
<HR>

<A NAME="removeFunctionTemplateFromCache(java.lang.String)"><!-- --></A><H3>
removeFunctionTemplateFromCache</H3>
<PRE>
void <B>removeFunctionTemplateFromCache</B>(java.lang.String&nbsp;functionName)</PRE>
<DL>
<DD>Removes a function template from the local cache.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>functionName</CODE> - the name of the function to be removed from the cache</DL>
</DD>
</DL>
<HR>

<A NAME="removeRecordMetaDataFromCache(java.lang.String)"><!-- --></A><H3>
removeRecordMetaDataFromCache</H3>
<PRE>
void <B>removeRecordMetaDataFromCache</B>(java.lang.String&nbsp;recordName)</PRE>
<DL>
<DD>Removes a record meta data from the local cache.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>recordName</CODE> - the name of the structure to be removed from the cache</DL>
</DD>
</DL>
<HR>

<A NAME="getCachedFunctionTemplateNames()"><!-- --></A><H3>
getCachedFunctionTemplateNames</H3>
<PRE>
java.lang.String[] <B>getCachedFunctionTemplateNames</B>()</PRE>
<DL>
<DD>Returns the names of the cached functions as a string array
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a string array of the cached functions (length 0 if the cache is empty)</DL>
</DD>
</DL>
<HR>

<A NAME="getCachedRecordMetaDataNames()"><!-- --></A><H3>
getCachedRecordMetaDataNames</H3>
<PRE>
java.lang.String[] <B>getCachedRecordMetaDataNames</B>()</PRE>
<DL>
<DD>Returns the names of the cached structures as a string array
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a string array of the cached structures (length 0 if the cache is empty)</DL>
</DD>
</DL>
<HR>

<A NAME="isUnicode()"><!-- --></A><H3>
isUnicode</H3>
<PRE>
boolean <B>isUnicode</B>()</PRE>
<DL>
<DD>Returns whether the repository contains both Unicode and Non-Unicode metadata.
 Repositories containing meta data for SAP systems running on Non-Unicode codepages 
 cannot contain meta data for unicode structures.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true, if the repository contains the metadata for Unicode representation of the
         contained metadata, false otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="clear()"><!-- --></A><H3>
clear</H3>
<PRE>
void <B>clear</B>()</PRE>
<DL>
<DD>Clear allows to empty both the function template cache as well as the record metadata cache completely.
 All metadata will be looked up again in the original source, which is generally much more expensive
 than looking it up in the cache. Therefore use this method carefully and avoid it in application code.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMonitor()"><!-- --></A><H3>
getMonitor</H3>
<PRE>
<A HREF="../../../../com/sap/conn/jco/monitor/JCoRepositoryMonitor.html" title="interface in com.sap.conn.jco.monitor">JCoRepositoryMonitor</A> <B>getMonitor</B>()</PRE>
<DL>
<DD>Returns a new created or available monitor instance for the repository
<P>
<DD><DL>

<DT><B>Returns:</B><DD>JCoRepositoryMonitor instance</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<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"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JCoRepository.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/sap/conn/jco/JCoRecordMetaData.html" title="interface in com.sap.conn.jco"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/sap/conn/jco/JCoRequest.html" title="interface in com.sap.conn.jco"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/sap/conn/jco/JCoRepository.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="JCoRepository.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


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

<HR>
<i>Copyright &#169; 2008 SAP AG. All Rights Reserved.</i>
</BODY>
</HTML>