com.businessobjects.rebean.wi
Interface Blocks

public interface Blocks

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

The Blocks interface defines a collection of blocks.

A block can be a table or a graph.

See Also:

DataProvider, BlockInfo.getBlocks()

Method Summary

int	getCount() Gets the number of blocks in the collection.
Block	getItem(int index) Returns the block at the specified position in the list.
Block	getItem(java.lang.String name) Returns a block by name.
Block	getItemByID(java.lang.String ID) Returns a Block identified by its ID.

Method Detail

getCount

int getCount()

Gets the number of blocks in the collection. This method always returns 0 if ReportEngine.getCanEditDocument() returns false. That is to say, the ReportEngine instance was opened to run Desktop Intelligence documents.

Returns:

The number of blocks.

getItem

Block getItem(int index)

Returns the block at the specified position in the list.

Parameters:

index - The index of the block to return (0 based).

Returns:

The block at the specified index.

Throws:

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

getItem

Block getItem(java.lang.String name)
              throws REException

Returns a block by name.

Parameters:

name - Name of the block to return.

Returns:

A block.

Throws:

REException - if the block name is invalid.

getItemByID

Block getItemByID(java.lang.String ID)
                  throws REException

Returns a Block identified by its ID.

Parameters:

ID - The id of the block to be returned.

Returns:

A block.

Throws:

REException - if the block ID is invalid.