com.sapportals.connector.metadata.objects

Interface IBusinessObject

All Superinterfaces:

IConnectorObject, IElement, ISOAPSerializable

public interface IBusinessObject

extends IElement, ISOAPSerializable

This interface exposes metadata for an EIS Business Object

Field Summary

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

BUSINESS_OBJECT, BUSINESS_OBJECT_GROUP

Method Summary

IAttribute	getAttribute(String attributeUniqueName) Returns an attribute of the business object.
Set	getAttributes() Returns the attributes of the business object.
IIndex	getIndex(String indexUniqueName) Return an IIndex object with the given uniqueName.
Set	getIndexes() Returns the indexes of this element.
IMethod	getMethod(String methodUniqueName) Returns a method of the element.
Set	getMethods() Returns the methods of this element.
IRelation	getRelation(String relationUniqueName) Returns a relation of this element given the unique name.
Set	getRelations() Deprecated. Use getRelationsEx()
List	getRelationsEx() Returns the relations of this business object.
Set	getRelationsToObject(String targetBusinessObject) Deprecated. Use getRelationsToObjectEx(String)
List	getRelationsToObjectEx(String targetBusinessObject) Returns the relations of this object to a target object ordered
List	getReversedRelationsEx() Returns the relations of this business object.
IIndex	retrievePrimaryKeyIndex() Return an IIndex object of the primary key

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

getDescription, getMetaType, getName, getType, getUniqueName, retrieveContainingGroup, retrieveTerm

Methods inherited from interface com.sapportals.connector.IConnectorObject

retrieveConnection

Method Detail

getAttributes

public Set getAttributes()
                  throws ConnectorException

Returns the attributes of the business object.

Returns:

A Set of IAttribute

Throws:

ConnectorException

See Also:

IAttribute

getAttribute

public IAttribute getAttribute(String attributeUniqueName)
                        throws AttributeNotFoundException,
                               ConnectorException

Returns an attribute of the business object.

Parameters:

attributeUniqueName - The unique name of the attribute.

Returns:

IAttribute interface.

Throws:

AttributeNotFoundException

ConnectorException

See Also:

IAttribute

getMethods

public Set getMethods()
               throws ConnectorException

Returns the methods of this element.

Returns:

A Set of IMethod.

Throws:

ConnectorException

See Also:

IMethod

getMethod

public IMethod getMethod(String methodUniqueName)
                  throws MethodNotFoundException,
                         ConnectorException

Returns a method of the element.

Parameters:

methodUniqueName - The unique name of the method.

Returns:

IMethod interface.

Throws:

MethodNotFoundException

ConnectorException

See Also:

IMethod

getRelations

public Set getRelations()
                 throws ConnectorException

Deprecated. Use getRelationsEx()

Returns the relations of this business object. Only relations wherein the business object is the source object are exposed. For example A.x1 -> B. y1 will be exposed and not C.z1 -> A.x3

Returns:

A Set of IRelation.

Throws:

ConnectorException

See Also:

IRelation

getRelationsEx

public List getRelationsEx()
                    throws ConnectorException

Returns the relations of this business object. Only relations wherein the business object is the source object are exposed. For example A.x1 -> B.y1 will be exposed and not C.z1 -> A.x3

Returns:

A Set of IRelation

Throws:

ConnectorException

See Also:

IRelation

getReversedRelationsEx

public List getReversedRelationsEx()
                            throws ConnectorException

Returns the relations of this business object. Only relations wherein the business object is the target object are exposed. For example C.z1 -> A.x3 will be exposed and not A.x1 -> B.y1

Returns:

A Set of IRelation

Throws:

ConnectorException

See Also:

IRelation

getRelation

public IRelation getRelation(String relationUniqueName)
                      throws RelationNotFoundException,
                             ConnectorException

Returns a relation of this element given the unique name.

Parameters:

relationUniqueName - The relation unique name.

Returns:

IRelation

Throws:

RelationNotFoundException

ConnectorException

See Also:

IRelation

getRelationsToObject

public Set getRelationsToObject(String targetBusinessObject)
                         throws ConnectorException

Deprecated. Use getRelationsToObjectEx(String)

Returns the relations of this object to a target object

Parameters:

targetBusinessObject - the targetBusinessObject

Returns:

Set

Throws:

ConnectorException

getRelationsToObjectEx

public List getRelationsToObjectEx(String targetBusinessObject)
                            throws ConnectorException

Returns the relations of this object to a target object ordered

Parameters:

targetBusinessObject - the targetBusinessObject

Returns:

List

Throws:

ConnectorException

getIndexes

public Set getIndexes()
               throws ConnectorException

Returns the indexes of this element.

Returns:

A Set of IIndex.

Throws:

ConnectorException

See Also:

IIndex

getIndex

public 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

ConnectorException

See Also:

IIndex

retrievePrimaryKeyIndex

public IIndex retrievePrimaryKeyIndex()
                               throws ConnectorException

Return an IIndex object of the primary key

Returns:

IIndex the primary key

Throws:

ConnectorException

See Also:

IIndex