com.sapportals.connector.metadata.structures

Interface IStructure

All Superinterfaces:
ISOAPSerializable
All Known Subinterfaces:
IArrayStructure, IExtendedStructure, IFieldStructure, IRecordSetStructure, IRecordStructure, IStructureWrapper, IUnionStructure

public interface IStructure
extends ISOAPSerializable

This base interface exposes metadata for data structures


Field Summary
static int STRUCTURE_TYPE_ARRAY
          Represents a record set with a single field of any of the other structure types.
static int STRUCTURE_TYPE_COLUMN
          Deprecated. Use STRUCTURE_TYPE_ARRAY instead
static int STRUCTURE_TYPE_FIELD
          Represents a primitive type The specific primitive type can be retrieved by calling IFieldStructure.getType()
static int STRUCTURE_TYPE_RECORD
          Represents a single record
static int STRUCTURE_TYPE_RECORD_SET
          Represents a record set
static int STRUCTURE_TYPE_UNION
          Represents a union - one of the primitive (will be determined in runtime).
 
Method Summary
 int retrieveStructureTypeCode()
          Returns the type code of the structure.
 

Field Detail

STRUCTURE_TYPE_FIELD

static final int STRUCTURE_TYPE_FIELD
Represents a primitive type The specific primitive type can be retrieved by calling IFieldStructure.getType()

See Also:
IFieldStructure, Constant Field Values

STRUCTURE_TYPE_RECORD_SET

static final int STRUCTURE_TYPE_RECORD_SET
Represents a record set

See Also:
IRecordSetStructure, Constant Field Values

STRUCTURE_TYPE_RECORD

static final int STRUCTURE_TYPE_RECORD
Represents a single record

See Also:
IRecordStructure, Constant Field Values

STRUCTURE_TYPE_COLUMN

static final int STRUCTURE_TYPE_COLUMN
Deprecated. Use STRUCTURE_TYPE_ARRAY instead
See Also:
Constant Field Values

STRUCTURE_TYPE_ARRAY

static final int STRUCTURE_TYPE_ARRAY
Represents a record set with a single field of any of the other structure types.

See Also:
IArrayStructure, Constant Field Values

STRUCTURE_TYPE_UNION

static final int STRUCTURE_TYPE_UNION
Represents a union - one of the primitive (will be determined in runtime). Possible types can be retrieved by IUnionStructure.getPossibleTypes(). In runtime, one of those types will be returned. This type can be determined by introspection

See Also:
IUnionStructure, Constant Field Values
Method Detail

retrieveStructureTypeCode

int retrieveStructureTypeCode()
Returns the type code of the structure.

Returns:
STRUCTURE_TYPE_FIELD, STRUCTURE_TYPE_RESULT_SET, STRUCTURE_TYPE_RECORD, STRUCTURE_TYPE_COLUMN=STRUCTURE_TYPE_ARRAY, STRUCTURE_TYPE_UNION
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 2015 SAP AG Complete Copyright Notice