com.sapportals.connector.metadata.structures
Interface IRecordStructure

All Superinterfaces:

ISOAPSerializable, IStructure

All Known Subinterfaces:

IRecordSetStructure

public interface IRecordStructure

extends IStructure, ISOAPSerializable

This interface exposes metadata for a record

Version:

1.0

Fields inherited from interface com.sapportals.connector.metadata.structures.IStructure

STRUCTURE_TYPE_ARRAY, STRUCTURE_TYPE_COLUMN, STRUCTURE_TYPE_FIELD, STRUCTURE_TYPE_RECORD, STRUCTURE_TYPE_RECORD_SET, STRUCTURE_TYPE_UNION

Method Summary

java.lang.String	getFieldName(int fieldIndex) Returns the name of the requested field
java.util.List	getFields() Returns a List of pairs of fields names and IStructure that represent the fields in the record set.
IStructure	getFieldType(int fieldIndex) Returns the type of the requested field by its index
IStructure	getFieldType(java.lang.String fieldName) Returns an IStructure interface containing metadata for a field type.
java.util.List	retrieveFieldNames() Returns a String list of all the fields in the record.
int	retrieveNumberOfFields() Returns the number of fields in the record.

Methods inherited from interface com.sapportals.connector.metadata.structures.IStructure

retrieveStructureTypeCode

Method Detail

getFieldType

public IStructure getFieldType(java.lang.String fieldName)
                        throws FieldNotFoundException

Returns an IStructure interface containing metadata for a field type.

Parameters:

fieldName - the name of the record field.

Returns:

IStructure interface.

See Also:

IStructure

retrieveFieldNames

public java.util.List retrieveFieldNames()
                                  throws ConnectorException

Returns a String list of all the fields in the record.

Returns:

A list of field names.

getFields

public java.util.List getFields()
                         throws ConnectorException

Returns a List of pairs of fields names and IStructure that represent the fields in the record set.

Returns:

A List of field names and structures.

getFieldName

public java.lang.String getFieldName(int fieldIndex)
                              throws FieldNotFoundException,
                                     ConnectorException

Returns the name of the requested field

Parameters:

fieldIndex - the index of the field

Returns:

A list of field names.

getFieldType

public IStructure getFieldType(int fieldIndex)
                        throws FieldNotFoundException,
                               ConnectorException

Returns the type of the requested field by its index

Returns:

IStructure the structure of the requested field

See Also:

IStructure

retrieveNumberOfFields

public int retrieveNumberOfFields()
                           throws ConnectorException

Returns the number of fields in the record.

Returns:

integer