com.sapportals.connector.metadata.objects

Interface IBusinessObject

All Superinterfaces:

IBOElement, IConnectorObject, IElement, IGenericElement, ISOAPSerializable

public interface IBusinessObject
extends IBOElement, ISOAPSerializable

This interface exposes metadata for an EIS Business Object

Field Summary

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

retrieveContainingGroup

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

getType

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

Method Detail

getAttributes

Set<IAttribute> getAttributes()
                       throws ConnectorException

Returns the attributes of the business object.

Returns:

a Set of IAttribute

Throws:

ConnectorException - if connector is failed

See Also:

IAttribute

getAttribute

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 - if attribute not found

ConnectorException - if connector is failed

See Also:

IAttribute

getMethods

Set<IMethod> getMethods()
                 throws ConnectorException

Returns the methods of this element.

Returns:

a Set of IMethod.

Throws:

ConnectorException - if connector is failed

See Also:

IMethod

getMethod

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 - if method not found

ConnectorException - if connector is failed

See Also:

IMethod

getRelations

Set<IRelation> 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 - if connector is failed

See Also:

IRelation

getRelationsEx

List<IRelation> 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:

List of IRelation

Throws:

ConnectorException - if connector is failed

See Also:

IRelation

getReversedRelationsEx

List<IRelation> 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:

List of IRelation

Throws:

ConnectorException - if connector is failed

See Also:

IRelation

getRelation

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 - if relation not found

ConnectorException - if connector is failed

See Also:

IRelation

getRelationsToObject

Set<IRelation> 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 of IRelation interfaces

Throws:

ConnectorException - if connector is failed

getRelationsToObjectEx

List<IRelation> getRelationsToObjectEx(String targetBusinessObject)
                                throws ConnectorException

Returns the relations of this object to a target object ordered

Parameters:

targetBusinessObject - the targetBusinessObject

Returns:

List of IRelation interfaces

Throws:

ConnectorException - if connector is failed

getIndexes

Set<IIndex> getIndexes()
                throws ConnectorException

Returns the indexes of this element.

Returns:

a Set of IIndex.

Throws:

ConnectorException - if connector is failed

See Also:

IIndex

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

retrievePrimaryKeyIndex

IIndex retrievePrimaryKeyIndex()
                        throws ConnectorException

Return an IIndex object of the primary key

Returns:

IIndex the primary key

Throws:

ConnectorException - if connector is failed

See Also:

IIndex