com.sap.caf.eu.gp.bo.utility.api

Interface IGPBusinessObjectAttributeLocator

public interface IGPBusinessObjectAttributeLocator

Version:

1.0

Method Summary

IGPBusinessObjectAttributeLocator	addLocator(IGPLabel label) Add a Locator to this BusinessObjectAttributeLocator by a given Label.
Enumeration	createLocatorEnumeration() Create an Enumeration of all Locator of this BusinessObjectAttributeLocator.
IGPLabel	getLabel() Retrieve the Label of this BusinessObjectAttributeLocator.
IGPBusinessObjectAttributeLocator	getLocator(IGPLabel label) retrieve a Locator of this BusinessObjectAttributeLocator by a given Label.
int	getLocatorCount() Retrieve the Count of all Locator of this BusinessObjectAttributeLocator.
IGPBusinessObjectAttributeLocator	removeLocator(IGPLabel label) Remove a Locator from this BusinessObjectAttributeLocator by a given Label.

Method Detail

addLocator

IGPBusinessObjectAttributeLocator addLocator(IGPLabel label)
                                             throws GPInvocationException

Add a Locator to this BusinessObjectAttributeLocator by a given Label. After completion this BusinessObjectAttributeLocator contains a Locator with a Label equal to the given one. In case this BusinessObjectAttributeLocator did not already contain such a Locator a new one is created on the fly.

Parameters:

label - the Label for the Locator to add, never null

Returns:

the added Locator, never null

Throws:

InvocationException - in case the given Label is invalid

GPInvocationException

createLocatorEnumeration

Enumeration createLocatorEnumeration()

Create an Enumeration of all Locator of this BusinessObjectAttributeLocator. The Enumeration contains IBusinessObjectAttributeLocator entries in random sequence.

Returns:

the created Enumeration, never null

getLabel

IGPLabel getLabel()

Retrieve the Label of this BusinessObjectAttributeLocator.

Returns:

the retrieved Label, never null

getLocator

IGPBusinessObjectAttributeLocator getLocator(IGPLabel label)
                                             throws GPInvocationException

retrieve a Locator of this BusinessObjectAttributeLocator by a given Label.

Parameters:

label - the Label of the Locator to retrieve, never null

Returns:

the retrieved Locator, null in case none was found

Throws:

InvocationException - in case the given Label is invalid

GPInvocationException

getLocatorCount

int getLocatorCount()

Retrieve the Count of all Locator of this BusinessObjectAttributeLocator.

Returns:

the retrieved Count

removeLocator

IGPBusinessObjectAttributeLocator removeLocator(IGPLabel label)
                                                throws GPInvocationException

Remove a Locator from this BusinessObjectAttributeLocator by a given Label.

Parameters:

label - the Label of the Locator to remove, never null

Returns:

the removed Locator, null in case none was found

Throws:

InvocationException - in case the given Label is invalid

GPInvocationException