com.businessobjects.rebean.wi
Interface DrillElements

public interface DrillElements

The DrillElements interface provides access to the list of DrillElements. This interface is used only in drill mode. Once the executeDrill is called, you must not work on this object, but create a new one from DrillInfo.

See Also:

DrillPath, DrillInfo

Method Summary

DrillElement	add() Adds an item to the list.
int	getCount() Returns the current size of the DrillElements list.
DrillElement	getItem(int index) Returns the specified item of the list.
DrillElement	getItem(java.lang.String objectID) Returns the item set by the client by its object ID.
void	remove(DrillElement elm) Removes a item from the list.
void	removeAll() Removes all the items you have added.

Method Detail

getCount

int getCount()

Returns the current size of the DrillElements list.

Returns:

the current size of the DrillElements list.

getItem

DrillElement getItem(int index)

Returns the specified item of the list.

Parameters:

index - The index of the drill element.

Returns:

the specified item of the list.

getItem

DrillElement getItem(java.lang.String objectID)
                     throws REException

Returns the item set by the client by its object ID.

Parameters:

objectID - The object ID of the drill element.

Returns:

the drill element by specifying it's object ID.

Throws:

REException

add

DrillElement add()

Adds an item to the list. This method is used for the user to add any item to the list. In the case of a drill action, it returns DrillToElement or a DrillFromElement, depending on the previous call to get this DrillElements.

Returns:

a drill element.

See Also:

DrillToElement, DrillFromElement, DrillPath.getFrom(), DrillPath.getTo()

remove

void remove(DrillElement elm)

Removes a item from the list. Before the executeDrill call, you may want to remove an Item you have added to the list.

Parameters:

elm - The DrillElement instance.

removeAll

void removeAll()

Removes all the items you have added.