imetadata.html

SAP ERP的二次开发

</DL>
<HR>

<A NAME="addInfo(java.lang.String, int, int, int, int, int, java.lang.Object)"><!-- --></A><H3>
addInfo</H3>
<PRE>
public void <B>addInfo</B>(java.lang.String&nbsp;name,
                    int&nbsp;type,
                    int&nbsp;length,
                    int&nbsp;offset,
                    int&nbsp;decimals,
                    int&nbsp;flags,
                    java.lang.Object&nbsp;tab_meta_data)</PRE>
<DL>
<DD>Adds a new field descriptor to the meta-data object<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Field name for identifying this data field<DD><CODE>type</CODE> - Data field type<DD><CODE>length</CODE> - Data field length in bytes<DD><CODE>offset</CODE> - Data field offset in the internal JCO data buffer<DD><CODE>decimals</CODE> - Data field number of decimals (only necessary for the data types TYPE_BCD and TYPE_FLOAT)<DD><CODE>flags</CODE> - Bit-vector for additional attributes of the field. The vector can be ORed together from<BR>
 <table border=1>
 <tr><th>Flag</th><th>Description</th></tr>
 <tr><td><tt>IMPORT_PARAMETER</tt></td><td>The field is an import parameter</td></tr>
 <tr><td><tt>EXPORT_PARAMETER</tt></td><td>The field is an export parameter</td></tr>
 <tr><td><tt>OPTIONAL_PARAMETER</tt></td><td>The field is an optional parameter</td></tr>
 <tr><td><tt>INACTIVATE_PARAMETER</tt></td><td>Only used for table parameters,<BR>
                          indicating that the content of the table will not be sent to the server</td></tr>
 <tr><td><tt>NESTED_TYPE1_STRUCTURE</tt></td><td>The field is a nested TYPE1 structure, i.e. a structure with a fixed length in memory, but not a flat layout</td></tr>
 </table><DD><CODE>tab_meta_data</CODE> - meta-data if the field is a complex field, i.e. structure or table, <code>null</code> otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="addInfo(java.lang.String, int, int, int, int, java.lang.String, java.lang.String, int, java.lang.Object, com.sap.mw.jco.IExtendedFieldMetaData)"><!-- --></A><H3>
addInfo</H3>
<PRE>
public void <B>addInfo</B>(java.lang.String&nbsp;name,
                    int&nbsp;type,
                    int&nbsp;length,
                    int&nbsp;offset,
                    int&nbsp;decimals,
                    java.lang.String&nbsp;defaults,
                    java.lang.String&nbsp;description,
                    int&nbsp;flags,
                    java.lang.Object&nbsp;tab_meta_data,
                    com.sap.mw.jco.IExtendedFieldMetaData&nbsp;extended)</PRE>
<DL>
<DD>Adds a new field descriptor to the meta-data object<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Field name for identifying this data field<DD><CODE>type</CODE> - Data field type<DD><CODE>length</CODE> - Data field length in bytes<DD><CODE>offset</CODE> - Data field offset in the internal JCO data buffer<DD><CODE>decimals</CODE> - Data field number of decimals (only necessary for the data types TYPE_BCD and TYPE_FLOAT)<DD><CODE>defaults</CODE> - Data Field default value<DD><CODE>description</CODE> - Descriptional text of the data field<DD><CODE>flags</CODE> - Bit-vector for additional attributes of the field. The vector can be ORed together from<BR>
 <table border=1>
 <tr><th>Flag</th><th>Description</th></tr>
 <tr><td><tt>IMPORT_PARAMETER</tt></td><td>The field is an import parameter</td></tr>
 <tr><td><tt>EXPORT_PARAMETER</tt></td><td>The field is an export parameter</td></tr>
 <tr><td><tt>OPTIONAL_PARAMETER</tt></td><td>The field is an optional parameter</td></tr>
 <tr><td><tt>INACTIVATE_PARAMETER</tt></td><td>Only used for table parameters,<BR>
                          indicating that the content of the table will not be sent to the server</td></tr>
 <tr><td><tt>NESTED_TYPE1_STRUCTURE</tt></td><td>The field is a nested TYPE1 structure, i.e. a structure with a fixed length in memory, but not a flat layout</td></tr>
 </table><DD><CODE>tab_meta_data</CODE> - meta-data if the field is a complex field, i.e. structure or table, <code>null</code> otherwise<DD><CODE>extended</CODE> - extended meta-data for this field or <code>null</code> if none available.</DL>
</DD>
</DL>
<HR>

<A NAME="getName(int)"><!-- --></A><H3>
getName</H3>
<PRE>
public java.lang.String <B>getName</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the field name of the data field at the specified index
 The field name is used for identfying a field in a structure or table row.<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 field name of the data field described by this meta information object.</DL>
</DD>
</DL>
<HR>

<A NAME="getTabName(int)"><!-- --></A><H3>
getTabName</H3>
<PRE>
public java.lang.String <B>getTabName</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the table/structure name of the data field or <code>null</code> if no table name is available<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 name of the data field described by this meta information object.</DL>
</DD>
</DL>
<HR>

<A NAME="getTabName(java.lang.String)"><!-- --></A><H3>
getTabName</H3>
<PRE>
public java.lang.String <B>getTabName</B>(java.lang.String&nbsp;field_name)</PRE>
<DL>
<DD>Returns the table/structure name of the data field or <code>null</code> if no table name is available<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field_name</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.</DL>
</DD>
</DL>
<HR>

<A NAME="getMetaData(int)"><!-- --></A><H3>
getMetaData</H3>
<PRE>
public <A HREF="../../../../com/sap/mw/jco/IMetaData.html">IMetaData</A> <B>getMetaData</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the meta-data if the specified data field is a table or structure.
 The method will return <code>null</code> if no meta-data are available<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 meta-data of the data field or <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="getMetaData(java.lang.String)"><!-- --></A><H3>
getMetaData</H3>
<PRE>
public <A HREF="../../../../com/sap/mw/jco/IMetaData.html">IMetaData</A> <B>getMetaData</B>(java.lang.String&nbsp;field_name)</PRE>
<DL>
<DD>Returns the meta-data if the specified data field is a table or structure.
 The method will return <code>null</code> if no meta-data are available<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field_name</CODE> - the name of the field<DT><B>Returns:</B><DD>The table/structure meta-data of the data field or <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="getExtendedFieldMetaData(int)"><!-- --></A><H3>
getExtendedFieldMetaData</H3>
<PRE>
public com.sap.mw.jco.IExtendedFieldMetaData <B>getExtendedFieldMetaData</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the extended field meta-data object at the specified index<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 meta-data object or <code>null</code> if not available</DL>
</DD>
</DL>
<HR>

<A NAME="getExtendedFieldMetaData(java.lang.String)"><!-- --></A><H3>
getExtendedFieldMetaData</H3>
<PRE>
public com.sap.mw.jco.IExtendedFieldMetaData <B>getExtendedFieldMetaData</B>(java.lang.String&nbsp;field_name)</PRE>
<DL>
<DD>Returns the extended meta-data object for the field with the specified name<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field_name</CODE> - the name of the field<DT><B>Returns:</B><DD>the extended field meta-data object or <code>null</code> if not available</DL>
</DD>
</DL>
<HR>

<A NAME="getLength(int)"><!-- --></A><H3>
getLength</H3>
<PRE>
public int <B>getLength</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the length of the data field at the specified index<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>
public int <B>getLength</B>(java.lang.String&nbsp;field_name)</PRE>
<DL>
<DD>Returns the length of the field with the specified name<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field_name</CODE> - the name of the field<DT><B>Returns:</B><DD>data field length</DL>
</DD>
</DL>
<HR>

<A NAME="getInternalLength(int)"><!-- --></A><H3>
getInternalLength</H3>
<PRE>
public int <B>getInternalLength</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the internal length of the data field at the specified index<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 internal length<DT><B>Since: </B><DD>JCo 2.0</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getInternalLength(java.lang.String)"><!-- --></A><H3>
getInternalLength</H3>
<PRE>
public int <B>getInternalLength</B>(java.lang.String&nbsp;field_name)</PRE>
<DL>
<DD>Returns the internal length of the field with the specified name<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field_name</CODE> - the name of the field<DT><B>Returns:</B><DD>data field internal length<DT><B>Since: </B><DD>JCo 2.0</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getOffset(int)"><!-- --></A><H3>
getOffset</H3>
<PRE>
public int <B>getOffset</B>(int&nbsp;index)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>only used for internal purposes</I>
<P>
<DD>Returns the offset of the data field at the specified index<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 offset</DL>
</DD>
</DL>
<HR>

<A NAME="getOffset(java.lang.String)"><!-- --></A><H3>
getOffset</H3>
<PRE>
public int <B>getOffset</B>(java.lang.String&nbsp;field_name)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>only used for internal purposes</I>
<P>
<DD>Returns the offset for the field with the specified name<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field_name</CODE> - the name of the field<DT><B>Returns:</B><DD>data field offset</DL>
</DD>
</DL>
<HR>

<A NAME="getType(int)"><!-- --></A><H3>
getType</H3>
<PRE>
public int <B>getType</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the JCO type of the data field at the specified index<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>
public int <B>getType</B>(java.lang.String&nbsp;field_name)</PRE>
<DL>
<DD>Returns the type of the data for the field with the specified name<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field_name</CODE> - the name of the field<DT><B>Returns:</B><DD>the JCO data type</DL>
</DD>
</DL>
<HR>

<A NAME="getTypeAsString(int)"><!-- --></A><H3>
getTypeAsString</H3>
<PRE>
public java.lang.String <B>getTypeAsString</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the type of the data field at the specified index<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>
public java.lang.String <B>getTypeAsString</B>(java.lang.String&nbsp;field_name)</PRE>
<DL>
<DD>Returns the type of the data field for the field with the specified name<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field_name</CODE> - the name of the field<DT><B>Returns:</B><DD>a string description of the JCO data type</DL>
</DD>
</DL>
<HR>

<A NAME="getDecimals(int)"><!-- --></A><H3>
getDecimals</H3>
<PRE>
public int <B>getDecimals</B>(int&nbsp;index)</PRE>
<DL>
<DD>Returns the number of decimals of the data field at the specified index
 Decimals are only necessary for the JCO data types TYPE_BCD and TYPE_FLOAT, respectively.<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 number of decimals.</DL>
</DD>
</DL>
<HR>

<A NAME="getDecimals(java.lang.String)"><!-- --></A><H3>
getDecimals</H3>
<PRE>