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


Field Summary
 
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
 String getFieldName(int fieldIndex)
          Returns the name of the requested field
 List<IStructure> getFields()
          Returns a List of fields types 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(String fieldName)
          Returns an IStructure interface containing metadata for a field type.
 List<String> 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

IStructure getFieldType(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.
Throws:
FieldNotFoundException
See Also:
IStructure

retrieveFieldNames

List<String> retrieveFieldNames()
                                throws ConnectorException
Returns a String list of all the fields in the record.

Returns:
a list of field names.
Throws:
ConnectorException

getFields

List<IStructure> getFields()
                           throws ConnectorException
Returns a List of fields types IStructure that represent the fields in the record set.

Returns:
a List of field structures.
Throws:
ConnectorException

getFieldName

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.
Throws:
FieldNotFoundException
ConnectorException

getFieldType

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
Throws:
FieldNotFoundException
ConnectorException
See Also:
IStructure

retrieveNumberOfFields

int retrieveNumberOfFields()
                           throws ConnectorException
Returns the number of fields in the record.

Returns:
integer
Throws:
ConnectorException
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-BASIS-API [sap.com] tc/epbc/connectivityfw/api api EP-PIN
[sap.com] FRAMEWORK-EXT [sap.com] tc/conn/connectorframeworkdeprecated - EP-CON-CF
[sap.com] FRAMEWORK-EXT [sap.com] tc/conn/connectorframeworkdeprecated default EP-CON-CF


Copyright 2011 SAP AG Complete Copyright Notice