com.sapportals.connector.metadata.structures
Interface IStructure

All Superinterfaces:

ISOAPSerializable

All Known Subinterfaces:

IArrayStructure, IFieldStructure, IRecordSetStructure, IRecordStructure, IUnionStructure

public interface IStructure

extends ISOAPSerializable

This base interface exposes metadata for data structures

Version:

1.0

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

public static final int STRUCTURE_TYPE_FIELD

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

See Also:

IFieldStructure

STRUCTURE_TYPE_RECORD_SET

public static final int STRUCTURE_TYPE_RECORD_SET

Represents a record set

See Also:

IRecordSetStructure

STRUCTURE_TYPE_RECORD

public static final int STRUCTURE_TYPE_RECORD

Represents a single record

See Also:

IRecordStructure

STRUCTURE_TYPE_COLUMN

public static final int STRUCTURE_TYPE_COLUMN

Deprecated. Use STRUCTURE_TYPE_ARRAY instead

STRUCTURE_TYPE_ARRAY

public static final int STRUCTURE_TYPE_ARRAY

Represents a record set with a single field of any of the other structure types.

See Also:

IArrayStructure

STRUCTURE_TYPE_UNION

public 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

Method Detail

retrieveStructureTypeCode

public 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