com.sapportals.connector.metadata.objects

Interface IAttribute

All Superinterfaces:

IConnectorObject, IGenericElement, ISOAPSerializable

public interface IAttribute
extends ISOAPSerializable, IGenericElement

This interface exposes metadata for an attribute of an EIS Business Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	NULLABLE_NO Cannot be null
static int	NULLABLE_UNKNOWN Possibly be null
static int	NULLABLE_YES Can be null

Fields inherited from interface com.sapportals.connector.metadata.objects.IGenericElement

ATTRIBUTE, BUSINESS_OBJECT, BUSINESS_OBJECT_GROUP, FUNCTION, RELATION

Method Summary

Modifier and Type	Method and Description
Object	getDefaultValue() Returns the default value for this parameter.
IIndex	getIndex(String indexUniqueName) Return an IIndex object with the given uniqueName.
Set<String>	getIndexes() Return a Set of Strings each one is unique index name involved with this attribute
int	getPosition() Returns the position (index) of the attribute in the object, if any if position is undefined, returns IConnectorMetaData.UNDEFINED
IStructure	getStructure() Returns the metadata describing the structure of this attribute.
int	isNullable() Returns whether the attribute is optional.
IBusinessObject	retrieveParentBusinessObject() Returns the business object composing this attribute.

Methods inherited from interface com.sapportals.connector.metadata.objects.IGenericElement

getDescription, getElementType, getMetaType, getName, getNamespace, getUniqueName, retrieveTerm

Methods inherited from interface com.sapportals.connector.IConnectorObject

retrieveConnection

Field Detail

NULLABLE_UNKNOWN

static final int NULLABLE_UNKNOWN

Possibly be null

See Also:

Constant Field Values

NULLABLE_NO

static final int NULLABLE_NO

Cannot be null

See Also:

Constant Field Values

NULLABLE_YES

static final int NULLABLE_YES

Can be null

See Also:

Constant Field Values

Method Detail

retrieveParentBusinessObject

IBusinessObject retrieveParentBusinessObject()

Returns the business object composing this attribute.

Returns:

parent IBusinessObject interface.

See Also:

IBusinessObject

getStructure

IStructure getStructure()
                 throws ConnectorException

Returns the metadata describing the structure of this attribute.

Returns:

IStructure - the metadata describing the structure of this attribute.

Throws:

ConnectorException - if connector is failed

See Also:

IStructure

getIndexes

Set<String> getIndexes()
                throws ConnectorException

Return a Set of Strings each one is unique index name involved with this attribute

Returns:

Set of Strings

Throws:

ConnectorException - if connector is failed

getIndex

IIndex getIndex(String indexUniqueName)
         throws IndexNotFoundException,
                ConnectorException

Return an IIndex object with the given uniqueName.

Parameters:

indexUniqueName - the index unique name

Returns:

IIndex

Throws:

IndexNotFoundException - if index not found

ConnectorException - if connector is failed

See Also:

IIndex

isNullable

int isNullable()

Returns whether the attribute is optional. an optional attribute may by NULL.

Returns:

whether the attribute is optional.

getDefaultValue

Object getDefaultValue()
                throws ConnectorException

Returns the default value for this parameter. may return NULL

Returns:

the default value for this parameter.

Throws:

ConnectorException - if connector is failed

getPosition

int getPosition()

Returns the position (index) of the attribute in the object, if any if position is undefined, returns IConnectorMetaData.UNDEFINED

Returns:

int the position of the attribute