com.sapportals.connector.metadata.objects
Interface IAttribute

All Superinterfaces:

ISOAPSerializable

public interface IAttribute

extends ISOAPSerializable

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

Version:

1.0

Field Summary

static int	NULLABLE_NO Cannot be null
static int	NULLABLE_UNKNOWN Possibly be null
static int	NULLABLE_YES Can be null

Method Summary

java.lang.Object	getDefaultValue() Returns the default value for this parameter. may return NULL
java.lang.String	getDescription() Returns the description of the attribute.
IIndex	getIndex(java.lang.String indexUniqueName) Return an IIndex object with the given uniqueName.
java.util.Set	getIndexes() Return a Set of Strings each one is unique index name involved with this attribute
java.lang.String	getName() Returns the name of the 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.
java.lang.String	getUniqueName() Returns the unique name of the attribute.
int	isNullable() Returns whether the attribute is optional. an optional attribute may by NULL.
IBusinessObject	retrieveParentBusinessObject() Returns the business object composing this attribute.
java.lang.String	retrieveTerm() Returns the term describing the parameter, for example "Attribute"

Field Detail

NULLABLE_UNKNOWN

public static final int NULLABLE_UNKNOWN

Possibly be null

NULLABLE_NO

public static final int NULLABLE_NO

Cannot be null

NULLABLE_YES

public static final int NULLABLE_YES

Can be null

Method Detail

retrieveParentBusinessObject

public IBusinessObject retrieveParentBusinessObject()

Returns the business object composing this attribute.

Returns:

parent IBusinessObject interface.

See Also:

IBusinessObject

getStructure

public IStructure getStructure()
                        throws ConnectorException

Returns the metadata describing the structure of this attribute.

Returns:

IStructure - the metadata describing the structure of this attribute.

See Also:

IStructure

getName

public java.lang.String getName()

Returns the name of the attribute.

Returns:

The attribute name.

getIndexes

public java.util.Set getIndexes()
                         throws ConnectorException

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

Returns:

Set of Strings.

getIndex

public IIndex getIndex(java.lang.String indexUniqueName)
                throws IndexNotFoundException,
                       ConnectorException

Return an IIndex object with the given uniqueName.

Parameters:

indexUniqueName - The index unique name.

Returns:

IIndex.

See Also:

IIndex

getUniqueName

public java.lang.String getUniqueName()

Returns the unique name of the attribute.

Returns:

String the attribute unique name.

getDescription

public java.lang.String getDescription()

Returns the description of the attribute.

Returns:

The attribute description.

retrieveTerm

public java.lang.String retrieveTerm()

Returns the term describing the parameter, for example "Attribute"

Returns:

The parameter term

isNullable

public int isNullable()

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

Returns:

boolean - whether the attribute is optional.

getDefaultValue

public java.lang.Object getDefaultValue()
                                 throws ConnectorException

Returns the default value for this parameter. may return NULL

Returns:

Object - the default value for this parameter.

getPosition

public 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