com.sapportals.connector.metadata.objects
Interface IIndex

All Superinterfaces:

ISOAPSerializable

public interface IIndex

extends ISOAPSerializable

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

Version:

1.0

Method Summary

IAttribute	getAttribute(java.lang.String attributeUniqueName) Returns an attribute composing this index given the unique name.
java.util.Set	getAttributes() Returns the attributes composing this index.
java.lang.String	getDescription() Returns the description of the index.
java.lang.String	getName() Returns the index name.
java.lang.String	getUniqueName() Returns the index unique name.
boolean	isPrimaryKey() Returns whether this index is a primary key.
IBusinessObject	retrieveParentBusinessObject() Returns the business object composing this index.
java.lang.String	retrieveTerm() Returns the term describing the parameter, for example "Index"

Method Detail

getName

public java.lang.String getName()

Returns the index name.

Returns:

String name of the index.

getUniqueName

public java.lang.String getUniqueName()

Returns the index unique name.

Returns:

String unique name of the index.

getAttributes

public java.util.Set getAttributes()
                            throws ConnectorException

Returns the attributes composing this index.

Returns:

A Set of IAttribute

See Also:

IAttribute

getAttribute

public IAttribute getAttribute(java.lang.String attributeUniqueName)
                        throws AttributeNotFoundException,
                               ConnectorException

Returns an attribute composing this index given the unique name.

Returns:

IAttribute

See Also:

IAttribute

retrieveParentBusinessObject

public IBusinessObject retrieveParentBusinessObject()

Returns the business object composing this index.

Returns:

parent IBusinessObject interface.

See Also:

IBusinessObject

isPrimaryKey

public boolean isPrimaryKey()

Returns whether this index is a primary key.

Returns:

boolean Whether this index is primary key.

getDescription

public java.lang.String getDescription()

Returns the description of the index.

Returns:

The index description.

retrieveTerm

public java.lang.String retrieveTerm()

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

Returns:

The parameter term