jcofield.html

jco book to connect java with SAP

</DL>
<HR>

<A NAME="getDescription()"><!-- --></A><H3>
getDescription</H3>
<PRE>
java.lang.String <B>getDescription</B>()</PRE>
<DL>
<DD>Returns a textual description for this field
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a text that describes the field or <tt>null</tt> if none available</DL>
</DD>
</DL>
<HR>

<A NAME="getTypeAsString()"><!-- --></A><H3>
getTypeAsString</H3>
<PRE>
java.lang.String <B>getTypeAsString</B>()</PRE>
<DL>
<DD>Returns the field's type as a string
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's type as a string</DL>
</DD>
</DL>
<HR>

<A NAME="getExtendedFieldMetaData()"><!-- --></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>()</PRE>
<DL>
<DD>Returns the extended field meta data object
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the extended field meta data object or <tt>null</tt> if not available</DL>
</DD>
</DL>
<HR>

<A NAME="getRecordMetaData()"><!-- --></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>()</PRE>
<DL>
<DD>Returns the field meta data object in case of complex object (table or structure),
  or null
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field meta data object or <tt>null</tt> if not available</DL>
</DD>
</DL>
<HR>

<A NAME="getClassNameOfValue()"><!-- --></A><H3>
getClassNameOfValue</H3>
<PRE>
java.lang.String <B>getClassNameOfValue</B>()</PRE>
<DL>
<DD>Returns the fully-qualified name of the Java class whose instances
  are manufactured if the method <tt>Field.getValue()</tt> is called
  to retrieve a value from a field.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the fully-qualified class name of the value object</DL>
</DD>
</DL>
<HR>

<A NAME="getValue()"><!-- --></A><H3>
getValue</H3>
<PRE>
java.lang.Object <B>getValue</B>()</PRE>
<DL>
<DD>Returns the field's value as an object
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as an object
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to an <tt>Object</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getString()"><!-- --></A><H3>
getString</H3>
<PRE>
java.lang.String <B>getString</B>()</PRE>
<DL>
<DD>Returns the field's value as a string
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a string
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>String</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getChar()"><!-- --></A><H3>
getChar</H3>
<PRE>
char <B>getChar</B>()</PRE>
<DL>
<DD>Returns the field's value as a character
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a <tt>char</tt>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>char</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getCharArray()"><!-- --></A><H3>
getCharArray</H3>
<PRE>
char[] <B>getCharArray</B>()</PRE>
<DL>
<DD>Returns the field's value as a char array
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the value of the specified field
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted  to a char array</DL>
</DD>
</DL>
<HR>

<A NAME="getShort()"><!-- --></A><H3>
getShort</H3>
<PRE>
short <B>getShort</B>()</PRE>
<DL>
<DD>Returns the field's value as a short
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a <tt>short</tt>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>short</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getInt()"><!-- --></A><H3>
getInt</H3>
<PRE>
int <B>getInt</B>()</PRE>
<DL>
<DD>Returns the field's value as an int
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as an int
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>int</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getLong()"><!-- --></A><H3>
getLong</H3>
<PRE>
long <B>getLong</B>()</PRE>
<DL>
<DD>Returns the field's value as a long
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a <tt>long</tt>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>long</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getBigInteger()"><!-- --></A><H3>
getBigInteger</H3>
<PRE>
java.math.BigInteger <B>getBigInteger</B>()</PRE>
<DL>
<DD>Returns the field's value as a <tt>BigInteger</tt> object
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a BigInteger object
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>BigInteger</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getDouble()"><!-- --></A><H3>
getDouble</H3>
<PRE>
double <B>getDouble</B>()</PRE>
<DL>
<DD>Returns the field's value as a double
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a double
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>double</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getByte()"><!-- --></A><H3>
getByte</H3>
<PRE>
byte <B>getByte</B>()</PRE>
<DL>
<DD>Returns the value of the i'th field as a byte
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a byte
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>byte</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getFloat()"><!-- --></A><H3>
getFloat</H3>
<PRE>
float <B>getFloat</B>()</PRE>
<DL>
<DD>Returns the field's value as a float
  Please use setValue(float value, ...) and getFloat(...) methods
  only if you operate with float values.
  Double value converted to float and back to double may also differ from original value.
  Please also don't mix those methods, because i.e.
  setting your values with setValue(float value, ...) and getting them using getDouble(...)
  may return not the same value.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a float
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>float</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getBigDecimal()"><!-- --></A><H3>
getBigDecimal</H3>
<PRE>
java.math.BigDecimal <B>getBigDecimal</B>()</PRE>
<DL>
<DD>Returns the field's value as a <tt>BigDecimal</tt> object
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a BigDecimal object
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>BigDecimal</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getDate()"><!-- --></A><H3>
getDate</H3>
<PRE>
java.util.Date <B>getDate</B>()</PRE>
<DL>
<DD>Returns the field's value as a <tt>Date</tt> object
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a Date object
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>Date</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getTime()"><!-- --></A><H3>
getTime</H3>
<PRE>
java.util.Date <B>getTime</B>()</PRE>
<DL>
<DD>Returns the field's value as a <tt>Date</tt> object
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a Date object
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco">ConversionException</A></CODE> - thrown if the value could not be converted to a <tt>Date</tt></DL>
</DD>
</DL>
<HR>

<A NAME="getByteArray()"><!-- --></A><H3>
getByteArray</H3>
<PRE>
byte[] <B>getByteArray</B>()</PRE>
<DL>
<DD>Returns the field's value as a <tt>byte[]</tt> array
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the field's value as a byte array