com.businessobjects.rebean.wi
Interface DrillBar

public interface DrillBar

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

The DrillBar interface represents a collection of drill objects. The drill bar can be customized by the developer by adding or removing universe objects. By default, the DrillBar is initialized with the report filters. This means that the filtered objects are automatically added to the drill bar. All modifications on the DrillBar will be commuted on the server side only after DrillInfo.executeDrill is called.

Method Summary

void	add(java.lang.String ObjectID) Adds the DrillBarObject by its universe object identifier.
int	getCount() Gets the number of objects in this drill bar.
DrillBarObject	getItem(int index) Returns the DrillBarObject at the specified position in the drill bar.
DrillBarObject	getItem(java.lang.String ID) Returns the DrillBarObject by specifying the object ID.
DrillBarObject	getItemByName(java.lang.String name) Returns the DrillBarObject by specifying the object name.
void	remove(int index) Removes the DrillBarObject at the specified position in the drill bar (0 based).
void	remove(java.lang.String objectID) Removes the DrillBarObject by its universe object identifier from the list and also remove it's filter.
void	removeAll() Removes all DrillBarObjects.

Method Detail

getCount

int getCount()

Gets the number of objects in this drill bar.

Returns:

the number of objects in this drill bar.

getItem

DrillBarObject getItem(int index)

Returns the DrillBarObject at the specified position in the drill bar.

Parameters:

index - the index of the object to return (0 based).

Returns:

the DrillBarObject at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is out of range (index < 0 || index >= getCount())

getItem

DrillBarObject getItem(java.lang.String ID)
                       throws REException

Returns the DrillBarObject by specifying the object ID.

Parameters:

ID - the object ID to return.

Returns:

a DrillBarObject, or null when no object in this collection has a ID corresponding to ID

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is out of range (index < 0 || index >= getCount())

REException - if the object ID is invalid

getItemByName

DrillBarObject getItemByName(java.lang.String name)
                             throws REException

Returns the DrillBarObject by specifying the object name.

Parameters:

name - the object name to return.

Returns:

a DrillBarObject, or null when no object in this collection has a name corresponding to name.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is out of range (index < 0 || index >= getCount())

REException - if the object name is invalid

add

void add(java.lang.String ObjectID)

Adds the DrillBarObject by its universe object identifier.

Parameters:

ObjectID - the universe object identifier to add.

remove

void remove(int index)

Removes the DrillBarObject at the specified position in the drill bar (0 based).

Parameters:

index - the index of the object to remove (0 based).

remove

void remove(java.lang.String objectID)

Removes the DrillBarObject by its universe object identifier from the list and also remove it's filter. executeDrill must be called to set the information.

Parameters:

objectID - the universe object identifier to remove.

removeAll

void removeAll()

Removes all DrillBarObjects.