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
 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
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
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
ConnectorException
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
Access Rights

This class can be accessed from:


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


Copyright 2011 SAP AG Complete Copyright Notice