com.businessobjects.rebean.wi
Interface ReportElement

All Superinterfaces:

TreeNode

All Known Subinterfaces:

Cell, FreeCell, PageHeaderFooter, ReportBlock, ReportBody, ReportCell, ReportContainer, ReportElementContainer, ReportStructure, SectionContainer

public interface ReportElement
extends TreeNode

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

ReportElement is a base interface for all elements in a report.

Method Summary

ReportElementContainer	getFather() Returns the father of this element, if any.
java.lang.String	getID() Returns a String, uniquely identifying this element.
ReportElement	getReportElement(int index) Returns the report element at the specified position in the list.
ReportElement	getReportElement(java.lang.String elemID) Gets a report element by unique identifier.
int	getReportElementCount() Gets the number of ReportElement children.

Methods inherited from interface com.businessobjects.rebean.wi.TreeNode

getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

getID

java.lang.String getID()

Returns a String, uniquely identifying this element.

Returns:

the id

See Also:

ReportElement.getReportElement(String)

getFather

ReportElementContainer getFather()

Returns the father of this element, if any. This is identical to TreeNode.getParent(), only with a more appropriate return type.

Returns:

the parent, or null when this element has no parent

getReportElement

ReportElement getReportElement(int index)

Returns the report element at the specified position in the list.

Parameters:

index - the index of the report element to return (0 based)

Returns:

the report element at the given index

Throws:

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

getReportElement

ReportElement getReportElement(java.lang.String elemID)

Gets a report element by unique identifier. All children are searched recursively, so that any report element that is a child of this element, directly or indirectly, might be returned.

Parameters:

elemID - the ID of the element to get

Returns:

the ReportElement with ID elemID, or null when there is no ReportElement child with ID elemID.

Throws:

java.lang.NullPointerException - when elemID is null

See Also:

ReportElement.getID()

getReportElementCount

int getReportElementCount()

Gets the number of ReportElement children. This method is identical to TreeNode.getChildCount().

Returns:

the number of ReportElement children