|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JCoListMetaData
Encapsulates the metadata of either a parameter list, a request, or a response. Each metadata element describes a field of these list oriented data containers in terms of name, type, length, etc. JCoListMetadata objects are mainly used to create parameter lists of a certain layout. JCoListMetadata contains all the metadata, which is specific to parameter lists.
JCoParameterList
,
JCoRequest
,
JCoResponse
Field Summary | |
---|---|
static int |
CHANGING_PARAMETER
Flag indicating an export parameter. |
static int |
EXPORT_PARAMETER
Flag indicating an export parameter. |
static int |
IMPORT_PARAMETER
Flag indicating an import parameter. |
static int |
OPTIONAL_PARAMETER
Flag indicating an optional parameter. |
Fields inherited from interface com.sap.conn.jco.JCoMetaData |
---|
TYPE_ABAPOBJECT, TYPE_BCD, TYPE_BOX, TYPE_BYTE, TYPE_CHAR, TYPE_DATE, TYPE_DECF16, TYPE_DECF34, TYPE_EXCEPTION, TYPE_FLOAT, TYPE_GENERIC_BOX, TYPE_INT, TYPE_INT1, TYPE_INT2, TYPE_INVALID, TYPE_ITAB, TYPE_NUM, TYPE_STRING, TYPE_STRUCTURE, TYPE_TABLE, TYPE_TIME, TYPE_XSTRING, UNINITIALIZED |
Method Summary | |
---|---|
void |
add(java.lang.String name,
int type,
int nucByteLength,
int ucByteLength,
int flags)
Adds a new scalar field descriptor to the metadata object. |
void |
add(java.lang.String name,
int type,
int nucByteLength,
int ucByteLength,
int decimals,
java.lang.String defaults,
java.lang.String description,
int flags,
java.lang.Object tabMetaData,
JCoExtendedFieldMetaData extended)
Adds a new field descriptor to the metadata object. |
void |
add(java.lang.String name,
int type,
int nucByteLength,
int ucByteLength,
int decimals,
java.lang.String defaults,
java.lang.String description,
int flags,
java.lang.Object tabMetaData,
java.lang.String recordFieldName,
JCoExtendedFieldMetaData extended)
Adds a new field descriptor to the metadata object. |
void |
add(java.lang.String name,
int type,
JCoRecordMetaData recordMetaData,
int flags)
Adds a new complex field descriptor to the metadata object. Complex fields are structures and tables. |
java.lang.String |
getDefault(int index)
Returns the default value of the data field at the specified index. |
java.lang.String |
getDefault(java.lang.String fieldName)
Returns the default value for the field with the specified name. |
java.lang.String |
getRecordFieldName(int index)
If the parameter is defined by referencing a field in a table or structure, the name of this field for the parameter field at the specified index is returned, null otherwise. |
java.lang.String |
getRecordFieldName(java.lang.String fieldName)
If the parameter is defined by referencing a field in a table or structure, the name of this field for the parameter field with the specified name is returned, null otherwise. |
boolean |
isChanging(int index)
Checks whether the field at the specified index is a changing parameter. |
boolean |
isChanging(java.lang.String fieldName)
Checks whether the field with the specified name is a changing parameter. |
boolean |
isException(int index)
Checks whether this field is an exception. |
boolean |
isException(java.lang.String fieldName)
Checks whether this field with the specified name is an exception. |
boolean |
isExport(int index)
Checks whether the field at the specified index is an export parameter. |
boolean |
isExport(java.lang.String fieldName)
Checks whether the field with the specified name is an export parameter. |
boolean |
isImport(int index)
Checks whether the field at the specified index is an import parameter. |
boolean |
isImport(java.lang.String fieldName)
Checks whether the field with the specified name is an import parameter. |
boolean |
isOptional(int index)
Checks whether the field at the specified index is an optional parameter. |
boolean |
isOptional(java.lang.String fieldName)
Checks whether the field with the specified name is an optional parameter. |
Field Detail |
---|
static final int OPTIONAL_PARAMETER
static final int IMPORT_PARAMETER
static final int EXPORT_PARAMETER
static final int CHANGING_PARAMETER
Method Detail |
---|
void add(java.lang.String name, int type, int nucByteLength, int ucByteLength, int flags)
name
- field name for identifying this data fieldtype
- field datatypenucByteLength
- data field length in bytes for non-Unicode layoutucByteLength
- data field length in bytes for Unicode layoutflags
- bit-vector for additional attributes of the field. The vector can be ORed together from
IMPORT_PARAMETER
- if the field is an import parameter
EXPORT_PARAMETER
- if the field is an export parameter
CHANGING_PARAMETER
- if the field is a changing parameter
OPTIONAL_PARAMETER
- if the field is an optional parameter
void add(java.lang.String name, int type, JCoRecordMetaData recordMetaData, int flags)
name
- field name for identifying this data fieldtype
- field datatyperecordMetaData
- the metadata for the structure or tableflags
- bit-vector for additional attributes of the field. The vector can be ORed together from
IMPORT_PARAMETER
- if the field is an import parameter
EXPORT_PARAMETER
- if the field is an export parameter
CHANGING_PARAMETER
- if the field is a changing parameter
OPTIONAL_PARAMETER
- if the field is an optional parameter
void add(java.lang.String name, int type, int nucByteLength, int ucByteLength, int decimals, java.lang.String defaults, java.lang.String description, int flags, java.lang.Object tabMetaData, JCoExtendedFieldMetaData extended)
name
- field name for identifying this data fieldtype
- field datatypenucByteLength
- data field length in bytes for non-Unicode layoutucByteLength
- data field length in bytes for Unicode layoutdecimals
- data field number of decimals (only necessary for the data types TYPE_BCD and TYPE_FLOAT)defaults
- data field default valuedescription
- descriptive text of the data fieldflags
- bit-vector for additional attributes of the field. The vector can be ORed together from
IMPORT_PARAMETER
- if the field is an import parameter
EXPORT_PARAMETER
- if the field is an export parameter
CHANGING_PARAMETER
- if the field is a changing parameter
OPTIONAL_PARAMETER
- if the field is an optional parameter
tabMetaData
- metadata for a complex field, if the field is a structure or a tableextended
- extended metadata for this field or null
if none is availablevoid add(java.lang.String name, int type, int nucByteLength, int ucByteLength, int decimals, java.lang.String defaults, java.lang.String description, int flags, java.lang.Object tabMetaData, java.lang.String recordFieldName, JCoExtendedFieldMetaData extended)
name
- field name for identifying this data fieldtype
- field datatypenucByteLength
- data field length in bytes for non-Unicode layoutucByteLength
- data field length in bytes for Unicode layoutdecimals
- data field number of decimals (only necessary for the data types TYPE_BCD and TYPE_FLOAT)defaults
- data field default valuedescription
- descriptive text of the data fieldflags
- bit-vector for additional attributes of the field. The vector can be ORed together from
IMPORT_PARAMETER
- if the field is an import parameter
EXPORT_PARAMETER
- if the field is an export parameter
CHANGING_PARAMETER
- if the field is a changing parameter
OPTIONAL_PARAMETER
- if the field is an optional parameter
tabMetaData
- metadata for a complex field, if the field is a structure or a tablerecordFieldName
- associated field name in a referenced table or structure metadataextended
- extended metadata for this field or null
if none is availableboolean isException(int index)
index
- the index of the field
true
if the specified field is an exception, false
otherwiseboolean isException(java.lang.String fieldName)
fieldName
- the name of the field
true
if the specified field is an exception, false
otherwise
JCoRuntimeException
- with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not existjava.lang.String getDefault(int index)
index
- the index of the field
java.lang.String getDefault(java.lang.String fieldName)
fieldName
- the name of the field
JCoRuntimeException
- with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not existjava.lang.String getRecordFieldName(int index)
null
otherwise. In the first
case getRecordTypeName(index)
would contain the name of the enclosing record.
index
- the index of the parameter field
JCoMetaData.getRecordTypeName(int)
java.lang.String getRecordFieldName(java.lang.String fieldName)
null
otherwise. In the first
case getRecordTypeName(fieldName)
would contain the name of the enclosing record.
fieldName
- the name of the parameter field
JCoRuntimeException
- with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not existJCoMetaData.getRecordTypeName(String)
boolean isOptional(int index)
index
- the index of the field
true
if the specified field is an optional parameter, false
otherwiseboolean isOptional(java.lang.String fieldName)
fieldName
- the name of the field
true
if the specified field is an optional parameter, false
otherwise
JCoRuntimeException
- with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not existboolean isImport(int index)
index
- the index of the field
true
if the specified field is an import parameter, false
otherwiseboolean isImport(java.lang.String fieldName)
fieldName
- the name of the field
true
if the specified field is an import parameter, false
otherwise
JCoRuntimeException
- with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not existboolean isExport(int index)
index
- the index of the field
true
if the specified field is an export parameter, false
otherwiseboolean isExport(java.lang.String fieldName)
fieldName
- the name of the field
true
if the specified field is an export parameter, false
otherwise
JCoRuntimeException
- with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not existboolean isChanging(int index)
index
- the index of the field
true
if the specified field is a changing parameter, false
otherwiseboolean isChanging(java.lang.String fieldName)
fieldName
- the name of the field
true
if the specified field is a changing parameter, false
otherwise
JCoRuntimeException
- with group JCO_ERROR_FIELD_NOT_FOUND if a field with this name does not exist
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |