com.sapportals.connector.metadata.objects

Interface IBusinessObjectGroup

All Superinterfaces:

IBOElement, IConnectorObject, IElement, IGenericElement, ISOAPSerializable

public interface IBusinessObjectGroup
extends IBOElement, ISOAPSerializable

This interface exposes metadata for an EIS Business Object Group. A Business Object Group is a group of objects that may contain other Business Object Groups or Business Objects which are the actual elements that have attributes and methods

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
IElement	getContainedElement(String elementUniqueName) Returns a element contained by the business object group.
Set<IBusinessObject>	retrieveContainedBusinessObjects() Returns the Business Objects contained by the group - only business objects in last level.
Set<String>	retrieveContainedBusinessObjectsNames() Returns the Business Objects unique names contained by the group - only business objects in last level.
Set<IElement>	retrieveNextLevelElements() Returns the elements contained by the group (direct sons), direct sons can be BusinessObjectGroups or BusinessObjects.

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

retrieveNextLevelElements

Set<IElement> retrieveNextLevelElements()
                                 throws ConnectorException

Returns the elements contained by the group (direct sons), direct sons can be BusinessObjectGroups or BusinessObjects.

Returns:

a Set of IElement

Throws:

ConnectorException - if connector is failed

See Also:

IElement

retrieveContainedBusinessObjects

Set<IBusinessObject> retrieveContainedBusinessObjects()
                                               throws ConnectorException

Returns the Business Objects contained by the group - only business objects in last level.

Returns:

a Set of IBusinessObject.

Throws:

ConnectorException - if connector is failed

See Also:

IBusinessObject

getContainedElement

IElement getContainedElement(String elementUniqueName)
                      throws ElementNotFoundException,
                             ConnectorException

Returns a element contained by the business object group.

Parameters:

elementUniqueName - The unique name of the element.

Returns:

Set of IElement interface

Throws:

ElementNotFoundException - if element not found

ConnectorException - if connector is failed

See Also:

IElement

retrieveContainedBusinessObjectsNames

Set<String> retrieveContainedBusinessObjectsNames()
                                           throws ConnectorException

Returns the Business Objects unique names contained by the group - only business objects in last level. the unique names retrieve can be used as parameters for calling getContainedElement().

Returns:

a Set of String

Throws:

ConnectorException - if connector is failed