com.businessobjects.rebean.wi
Interface AlertersDictionary

public interface AlertersDictionary

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

The AlertersDictionary interface manages all Alerter objects contained in each Web Intelligence document.

Since:

11.5

See Also:

DocumentInstance.getStructure(), ReportStructure.getAlerters(), Alerter

Method Summary

Alerter	copyAlerter(Alerter alerter) Copies the alerter.
Alerter	getAlerter(int index) Returns the Alerter at a given index.
Alerter	getAlerterByID(java.lang.String id) Returns the Alerter using its known identifier.
int	getCount() Returns the number of Alerter objects contained in a document.
void	moveAlerter(int fromIndex, int toIndex) Deprecated.
void	removeAlerter(Alerter alerter) Removes the individual Alerter passed as a parameter from the list of Alerter associated to a document.
void	removeAlerterByID(java.lang.String id) Removes the Alerter indicated by its known identifier from the document.
void	removeAllAlerters() Removes all Alerter objects from a document.

Method Detail

getCount

int getCount()

Returns the number of Alerter objects contained in a document.

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.

getAlerterByID

Alerter getAlerterByID(java.lang.String id)

Returns the 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.

removeAlerter

void removeAlerter(Alerter alerter)

Removes the individual Alerter passed as a parameter from the list of Alerter associated to a document.

Parameters:

alerter - the Alerter to be removed.

removeAlerterByID

void removeAlerterByID(java.lang.String id)

Removes the Alerter indicated by its known identifier from the document.

Parameters:

id - the Alerter's identifier.

removeAllAlerters

void removeAllAlerters()

Removes all Alerter objects from a document.

moveAlerter

@Deprecated
void moveAlerter(int fromIndex,
                            int toIndex)

Deprecated.

Changes the position of an Alerter in the list of Alerter objects associated to a document.

Note: The index of Alerter objects in a document starts at 0.

Parameters:

fromIndex - the initial index of the alerter to be moved.

toIndex - the index to which the Alerter will be moved

Throws:

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

copyAlerter

Alerter copyAlerter(Alerter alerter)

Copies the alerter.

Parameters:

alerter - the alerter to be duplicated.

Returns:

the alerter copied.