com.businessobjects.rebean.wi
Interface Alerters

public interface Alerters

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

The Alerters interface contains a collection of Alerter objects. Alerter objects contained in each Alerters object are linked to individual TableCell and Cell object properties.

Since:

11.5

See Also:

Alertable, TableCell, Cell, Alerter

Method Summary

void	addAlerter(java.lang.String alerterID) Adds an Alerter to the collection.
Alerter	getAlerter(int index) Returns the Alerter at a given index.
Alerter	getAlerter(java.lang.String id) Returns a specific Alerter using its known identifier.
int	getCount() Returns the number of Alerter objects contained in the TableCell object.
void	moveAlerter(int fromIndex, int toIndex) Moves a alerter from one place to another in collection.
void	removeAlerter(int index) Removes an Alerter at a given index.
void	removeAlerter(java.lang.String alerterID) Removes an Alerter from the collection.
void	removeAllAlerters() Removes all Alerter objects from this object.

Method Detail

getCount

int getCount()

Returns the number of Alerter objects contained in the TableCell object.

Returns:

the number of Alerter objects.

getAlerter

Alerter getAlerter(int index)

Returns the Alerter at a given index.

Parameters:

index - the position of Alerter to be returned.

Returns:

the Alerter at a given index.

Throws:

IndexOutOfBoundsException - if index is out of range.

getAlerter

Alerter getAlerter(java.lang.String id)

Returns a specific Alerter using its known identifier.

Note: If the id passed is invalid, null is returned.

Parameters:

id - the identifier for a specific Alerter.

Returns:

the Alerter.

Throws:

NullPointerException - if alerterID is null.

addAlerter

void addAlerter(java.lang.String alerterID)

Adds an Alerter to the collection.

Parameters:

alerterID - the Alerter object's identifier.

Throws:

java.lang.NullPointerException - if alerterID is null.

java.lang.IllegalArgumentException - if alerterID doesn't exist in AlertersDictionary. }

removeAlerter

void removeAlerter(java.lang.String alerterID)

Removes an Alerter from the collection. If the Alerter has already been removed, nothing is done.

Parameters:

alerterID - the identifier for a specific Alerter.

Throws:

NullPointerException - if alerterID is null.

removeAlerter

void removeAlerter(int index)

Removes an Alerter at a given index.

Parameters:

index - the position of Alerter to be removed.

Throws:

IndexOutOfBoundsException - if index is out of range.

removeAllAlerters

void removeAllAlerters()

Removes all Alerter objects from this object. If all Alerter objects have already been removed, nothing is done.

moveAlerter

void moveAlerter(int fromIndex,
                 int toIndex)

Moves a alerter from one place to another in collection.

Parameters:

fromIndex - the initial index of the alerter to be moved (0 based)

toIndex - the final index of the alerter to be moved (0 based)

Throws:

java.lang.IndexOutOfBoundsException - if fromIndex or toIndex is out of range (fromIndex(toIndex) < 0 || fromIndex(toIndex) >= getCount())