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


Method Summary
 IAttribute getAttribute(String attributeUniqueName)
          Returns an attribute composing this index given the unique name.
 Set<IAttribute> getAttributes()
          Returns the attributes composing this index.
 String getDescription()
          Returns the description of the index.
 String getName()
          Returns the index name.
 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.
 String retrieveTerm()
          Returns the term describing the parameter, for example "Index"
 

Method Detail

getName

String getName()
Returns the index name.

Returns:
String name of the index

getUniqueName

String getUniqueName()
Returns the index unique name.

Returns:
String unique name of the index

getAttributes

Set<IAttribute> getAttributes()
                              throws ConnectorException
Returns the attributes composing this index.

Returns:
A Set of IAttribute
Throws:
ConnectorException
See Also:
IAttribute

getAttribute

IAttribute getAttribute(String attributeUniqueName)
                        throws AttributeNotFoundException,
                               ConnectorException
Returns an attribute composing this index given the unique name.

Returns:
IAttribute
Throws:
AttributeNotFoundException
ConnectorException
See Also:
IAttribute

retrieveParentBusinessObject

IBusinessObject retrieveParentBusinessObject()
Returns the business object composing this index.

Returns:
parent IBusinessObject interface
See Also:
IBusinessObject

isPrimaryKey

boolean isPrimaryKey()
Returns whether this index is a primary key.

Returns:
boolean Whether this index is primary key

getDescription

String getDescription()
Returns the description of the index.

Returns:
The index description

retrieveTerm

String retrieveTerm()
Returns the term describing the parameter, for example "Index"

Returns:
The parameter term
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] FRAMEWORK-EXT [sap.com] tc/conn/connectorframeworkdeprecated default EP-CON-CF
[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


Copyright 2011 SAP AG Complete Copyright Notice