jcometadata.html

jco book to connect java with SAP

</DD>
</DL>
<HR>

<A NAME="getRecordTypeName(java.lang.String)"><!-- --></A><H3>
getRecordTypeName</H3>
<PRE>
java.lang.String <B>getRecordTypeName</B>(java.lang.String&nbsp;fieldName)</PRE>
<DL>
<DD>Returns the table/structure or data element name of the data field or <code>null</code> if no table name or data element name is available
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - the name of the field
<DT><B>Returns:</B><DD>The table/structure name of the data field described by this meta information object.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not exist</DL>
</DD>
</DL>
<HR>

<A NAME="getRecordMetaData(int)"><!-- --></A><H3>
getRecordMetaData</H3>
<PRE>
<A HREF="../../../../com/sap/conn/jco/JCoRecordMetaData.html" title="interface in com.sap.conn.jco">JCoRecordMetaData</A> <B>getRecordMetaData</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the meta data object for the field, if the specified field is a 
 table or structure and was defined with a reference to a meta data object.
 <br/>
 The method will return <code>null</code> if no meta data are available.
 This is the case if the definition was done with type name or the meta data
 object was not obtained from repository.
 <em>Note:</em> to get the proper meta data object for the field
 it is possible to call
 <pre>
                JCoRepository repository;
      ...
        repository.getRecordMetaData(metaDataInstance.getRecordTypeName(index));
 </pre>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the field
<DT><B>Returns:</B><DD>The table/structure metadata of the data field or <code>null</code><DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/JCoMetaData.html#getRecordTypeName(int)"><CODE>getRecordTypeName(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getRecordMetaData(java.lang.String)"><!-- --></A><H3>
getRecordMetaData</H3>
<PRE>
<A HREF="../../../../com/sap/conn/jco/JCoRecordMetaData.html" title="interface in com.sap.conn.jco">JCoRecordMetaData</A> <B>getRecordMetaData</B>(java.lang.String&nbsp;fieldName)</PRE>
<DL>
<DD>Returns the meta data object for the field, if the specified field is a 
 table or structure and was defined with a reference to a meta data object.
 <br/>
 The method will return <code>null</code> if no meta data are available.
 This is the case if the definition was done with type name or the meta data
 object was not obtained from repository.
 <em>Note:</em> to get the proper meta data object for the field
 it is possible to call
 <pre>
                JCoRepository repository;
      ...
        repository.getRecordMetaData(metaDataInstance.getRecordTypeName(index));
 </pre>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - the name of the field
<DT><B>Returns:</B><DD>The table/structure metadata of the data field or <code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not exist<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/JCoMetaData.html#getRecordTypeName(java.lang.String)"><CODE>getRecordTypeName(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getExtendedFieldMetaData(int)"><!-- --></A><H3>
getExtendedFieldMetaData</H3>
<PRE>
<A HREF="../../../../com/sap/conn/jco/JCoExtendedFieldMetaData.html" title="interface in com.sap.conn.jco">JCoExtendedFieldMetaData</A> <B>getExtendedFieldMetaData</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the extended field metadata object at the specified index
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the field
<DT><B>Returns:</B><DD>the extended field metadata object or <code>null</code> if not available</DL>
</DD>
</DL>
<HR>

<A NAME="getExtendedFieldMetaData(java.lang.String)"><!-- --></A><H3>
getExtendedFieldMetaData</H3>
<PRE>
<A HREF="../../../../com/sap/conn/jco/JCoExtendedFieldMetaData.html" title="interface in com.sap.conn.jco">JCoExtendedFieldMetaData</A> <B>getExtendedFieldMetaData</B>(java.lang.String&nbsp;fieldName)</PRE>
<DL>
<DD>Returns the extended metadata object for the field with the specified name
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - the name of the field
<DT><B>Returns:</B><DD>the extended field metadata object or <code>null</code> if not available
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not exist</DL>
</DD>
</DL>
<HR>

<A NAME="getUnicodeByteLength(int)"><!-- --></A><H3>
getUnicodeByteLength</H3>
<PRE>
int <B>getUnicodeByteLength</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the length of the data field at the specified index for Unicode layout
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the field
<DT><B>Returns:</B><DD>data field length for Unicode layout</DL>
</DD>
</DL>
<HR>

<A NAME="getUnicodeByteLength(java.lang.String)"><!-- --></A><H3>
getUnicodeByteLength</H3>
<PRE>
int <B>getUnicodeByteLength</B>(java.lang.String&nbsp;fieldName)</PRE>
<DL>
<DD>Returns the length of the field with the specified name for Unicode layout
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - the name of the field
<DT><B>Returns:</B><DD>data field length for Unicode layout
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not exist</DL>
</DD>
</DL>
<HR>

<A NAME="getByteLength(int)"><!-- --></A><H3>
getByteLength</H3>
<PRE>
int <B>getByteLength</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the byte length of the data field for non-Unicode layout 
 at the specified index
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the field
<DT><B>Returns:</B><DD>data field length for non-Unicode layout</DL>
</DD>
</DL>
<HR>

<A NAME="getByteLength(java.lang.String)"><!-- --></A><H3>
getByteLength</H3>
<PRE>
int <B>getByteLength</B>(java.lang.String&nbsp;fieldName)</PRE>
<DL>
<DD>Returns the byte length of the field for non-Unicode layout 
 with the specified name
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - the name of the field
<DT><B>Returns:</B><DD>data field length for non-Unicode layout
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not exist</DL>
</DD>
</DL>
<HR>

<A NAME="getLength(int)"><!-- --></A><H3>
getLength</H3>
<PRE>
int <B>getLength</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the max length of the data field at the specified index.
 
 <ul>
 <li>for the character based types the char length will be returned.
 <li>for type <tt>STRING</tt> or <tt>XSTRING</tt> 0 
 <li>for type <tt>STRUCTURE</tt> or <tt>TABLE</tt> 0
 <li>for numerical types the byte length will be returned
 </ul>
 
 <em>Note: </em> in case of deep metadata the length for
 tables and structures can only be requested by their metadata
 directly.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the field
<DT><B>Returns:</B><DD>data field length</DL>
</DD>
</DL>
<HR>

<A NAME="getLength(java.lang.String)"><!-- --></A><H3>
getLength</H3>
<PRE>
int <B>getLength</B>(java.lang.String&nbsp;fieldName)</PRE>
<DL>
<DD>Returns the max length of the data field at the specified index.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - the name of the field
<DT><B>Returns:</B><DD>data field length
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not exist</DL>
</DD>
</DL>
<HR>

<A NAME="getType(int)"><!-- --></A><H3>
getType</H3>
<PRE>
int <B>getType</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the JCo data type of the data field at the specified index.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the field
<DT><B>Returns:</B><DD>the JCo data type</DL>
</DD>
</DL>
<HR>

<A NAME="getType(java.lang.String)"><!-- --></A><H3>
getType</H3>
<PRE>
int <B>getType</B>(java.lang.String&nbsp;fieldName)</PRE>
<DL>
<DD>Returns the JCo data type of the data for the field with the specified name
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - the name of the field
<DT><B>Returns:</B><DD>the JCo data type
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not exist</DL>
</DD>
</DL>
<HR>

<A NAME="getTypeAsString(int)"><!-- --></A><H3>
getTypeAsString</H3>
<PRE>
java.lang.String <B>getTypeAsString</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns a String representation of the JCo data type of the data field at the specified index
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index of the field
<DT><B>Returns:</B><DD>a String description of the JCo data type</DL>
</DD>
</DL>
<HR>

<A NAME="getTypeAsString(java.lang.String)"><!-- --></A><H3>
getTypeAsString</H3>
<PRE>
java.lang.String <B>getTypeAsString</B>(java.lang.String&nbsp;fieldName)</PRE>
<DL>
<DD>Returns a String representation of the JCo data type of the data field for the field with the specified name
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - the name of the field
<DT><B>Returns:</B><DD>a String description of the JCo data type
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not exist</DL>
</DD>
</DL>
<HR>

<A NAME="getClassNameOfField(java.lang.String)"><!-- --></A><H3>
getClassNameOfField</H3>
<PRE>
java.lang.String <B>getClassNameOfField</B>(java.lang.String&nbsp;fieldName)</PRE>
<DL>
<DD>Returns the fully-qualified name of the Java class whose instances