com.businessobjects.rebean.wi
Interface ReportStructure

All Superinterfaces:

ReportElement, ReportElementContainer, TreeNode, Unit

public interface ReportStructure
extends ReportElementContainer

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

ReportStructure is the representation of a document in editing mode.

Since:

6.5.0

See Also:

DocumentInstance.getStructure()

Method Summary

ReportContainer	createReport(java.lang.String name) Creates a new report of a given name.
AlertersDictionary	getAlerters() Return the Alerters defined in this DocumentInstance.
Function	getFunction(java.lang.String name) Return an individual function specified by it's name.
Function	getFunctionByID(int ID) Return a Function specified by it's ID.
FunctionCategory[]	getFunctionCategories() Return an array containing all function categories.
Function[]	getFunctions() Return an array containing all Web Intelligence Function objects.
Function[]	getFunctions(java.lang.String category) Return an array of functions belonging to a specific category name.
Function[]	getFunctionsByCategoryID(int categID) Returns an array of Function objects belonging to a specific category ID.
FormulaOperator[]	getOperators() Return an array containing all Web Intelligence operators.

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

copyReportElement, getWidth, move, removeAllChildren, removeReportElement, removeReportElementAt

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

getFather, getID, getReportElement, getReportElement, getReportElementCount

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

getChildAt, getChildCount, getIndex, getParent, isLeaf

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

getUnit, setUnit

Method Detail

createReport

ReportContainer createReport(java.lang.String name)

Creates a new report of a given name.

Parameters:

name - the name of the new report

Returns:

a ReportContainer object for the new report

getFunctions

Function[] getFunctions()

Return an array containing all Web Intelligence Function objects.

Functions are part of the Web Intelligence formula language.

Returns:

an array of Function objects sorted in the same order as the Report Panel

Since:

11.5

See Also:

FunctionCategory, FormulaOperator, Function

getOperators

FormulaOperator[] getOperators()

Return an array containing all Web Intelligence operators. Operators are used by the Web Intelligence formula language to describe an operation between Function objects.

Returns:

an array of FormulaOperator objects

Since:

11.5

See Also:

Function, FormulaOperator

getFunctionCategories

FunctionCategory[] getFunctionCategories()

Return an array containing all function categories.

Examples of possible categories are:

• All
• Aggregate
• Character
• Date and Time

Functions are part of the Web Intelligence formula language.

Returns:

an array of FunctionCategory sorted in the same order as the Report Panel.

Since:

11.5

See Also:

FunctionCategory, FormulaOperator, Function

getFunctionsByCategoryID

Function[] getFunctionsByCategoryID(int categID)

Returns an array of Function objects belonging to a specific category ID. If the given category ID does not exist, null is returned.

Examples of possible categories are:

• All
• Aggregate
• Character
• Date and Time

Functions are part of the Web Intelligence formula language.

Parameters:

categID - the category identifier to be searched for.

Returns:

an array of Function

Since:

11.5

See Also:

FunctionCategory, FormulaOperator, Function

getFunctionByID

Function getFunctionByID(int ID)

Return a Function specified by it's ID. If no Function exists with the given ID, returns null.

Functions are part of the Web Intelligence formula language.

Parameters:

ID - the function identifier

Returns:

Function the Function corresponding to the given ID

Since:

11.5

See Also:

FunctionCategory, FormulaOperator, Function, AllAvailableFunctionsIdentifiers

getFunctions

Function[] getFunctions(java.lang.String category)

Return an array of functions belonging to a specific category name.

Examples of possible categories are:

• All
• Aggregate
• Character
• Date and Time

If the given category name does not exist, an empty array is returned.

Parameters:

category - the category of subset functions

Returns:

an array of Function

Since:

11.5

getFunction

Function getFunction(java.lang.String name)

Return an individual function specified by it's name. If the given function name does not exist, returns null. Functions are part of the Web Intelligence formula language.

Parameters:

name - - the name of the function to be retrieved

Returns:

Function

Since:

11.5

See Also:

FunctionCategory, FormulaOperator, Function

getAlerters

AlertersDictionary getAlerters()

Return the Alerters defined in this DocumentInstance.

Returns:

a AlertersDictionary instance.

Since:

11.5

See Also:

AlertersDictionary, Alerters, Alerter