com.businessobjects.rebean.wi
Interface Link

All Superinterfaces:

ReportExpression, TreeNode

public interface Link
extends ReportExpression

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

The Link interface defines a link that contains several (more than two) ReportExpressions from several Data Providers.

Since:

B1

See Also:

SynchroManager.createLink(String name, String description, ReportExpression expr1, ReportExpression expr2)

Method Summary

void	addExpression(ReportExpression expr) Synchronize a ReportExpression from another DataProvider to the current Link instance.
java.lang.String	getDescription() Returns the description of the Link instance.
ReportExpression	getExpression(int index) Returns the ReportExpression object at position index in the Link instance.
ReportExpression	getExpression(java.lang.String exprID) Returns the ReportExpression object with the identifier exprID from the Link instance.
int	getExpressionCount() Returns the number of linked expressions.
Lov	getLOV() Returns the synchronized List of Values (LOV) for this Link instance.
SortInfo	getSortInfo() Returns the SortInfo instance defining the way in which this Link instance has been sorted.
void	removeExpression(int index) Removes the ReportExpression object at position index from the Link instance.
void	removeExpression(java.lang.String exprID) Removes the ReportExpression object with the identifier exprID from the Link instance.
void	setDescription(java.lang.String description) Changes the Link instance description.
void	setName(java.lang.String name) Changes the Link name.
void	setSourceExpression(int index) Sets the expression which will be used to provide default properties for the merged dimension.
void	setSourceExpression(java.lang.String exprID) Sets the expression which will be used to provide default properties for the merged dimension.

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

getDataSource, getDataSourceObject, getFormulaLanguageID, getID, getName, getQualification, getType

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

getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

getDescription

java.lang.String getDescription()

Returns the description of the Link instance.

Returns:

The description of the Link instance.

setDescription

void setDescription(java.lang.String description)

Changes the Link instance description.

Parameters:

description - The new Link description.

Throws:

ServerException - When an invalid Link exists in the Link collection.

setName

void setName(java.lang.String name)

Changes the Link name.

Parameters:

name - The new Link name.

Throws:

ServerException - When an invalid Link exists in the Link collection.

Note that an empty String isn't a valid name and will be substituted by the default name which is the name of its first expression.

addExpression

void addExpression(ReportExpression expr)

Synchronize a ReportExpression from another DataProvider to the current Link instance. The linked ReportExpression should have the same ObjectType, as current existing linked objects.

Parameters:

expr - The ReportExpression to be added.

Throws:

java.lang.NullPointerException - When expr is null.

java.lang.IllegalArgumentException - When expr:

• does not have the same ObjectType
• does not have a DIMENSION ObjectQualification

ServerException - When their is a synchronization processing error.

removeExpression

void removeExpression(java.lang.String exprID)

Removes the ReportExpression object with the identifier exprID from the Link instance.

Note: Their must be more than 2 ReportExpression object contained in the link for removeExpression to function correctly.

Parameters:

exprID - The unique identifier of the ReportExpression to be removed.

Throws:

java.lang.NullPointerException - When exprID is null.

DSObjectSynchroException - When getExpressionCount() returns 2.

ServerException - When their is a synchronization processing error.

See Also:

Link.getExpressionCount()

getExpressionCount

int getExpressionCount()

Returns the number of linked expressions.

Returns:

The number of linked expressions.

getExpression

ReportExpression getExpression(int index)

Returns the ReportExpression object at position index in the Link instance.

Parameters:

index - The position of the ReportExpression.

Returns:

The ReportExpression at position index.

Throws:

java.lang.IndexOutOfBoundsException - If index < 0 or index > Link.getExpressionCount().

removeExpression

void removeExpression(int index)

Removes the ReportExpression object at position index from the Link instance.

Note: Their must be more than 2 ReportExpression object contained in the link for removeExpression to function correctly.

Parameters:

index - The index of ReportExpression instance to be removed.

Throws:

java.lang.IndexOutOfBoundsException - If index < 0 or index > Link.getExpressionCount().

DSObjectSynchroException - When getExpressionCount() returns 2.

ServerException - When their is a synchronization processing error.

getExpression

ReportExpression getExpression(java.lang.String exprID)

Returns the ReportExpression object with the identifier exprID from the Link instance.

Parameters:

exprID - The unique identifier of the ReportExpression to be retrieved.

Returns:

The ReportExpression at position exprID.

getLOV

Lov getLOV()

Returns the synchronized List of Values (LOV) for this Link instance.

Returns:

the list of values, or null when there is no list of values

getSortInfo

SortInfo getSortInfo()

Returns the SortInfo instance defining the way in which this Link instance has been sorted.

Returns:

Returns the SortInfo instance associated to this Link.

setSourceExpression

void setSourceExpression(int index)

Sets the expression which will be used to provide default properties for the merged dimension.

Parameters:

index - the position of the ReportExpression.

Throws:

java.lang.IndexOutOfBoundsException - If index < 0 or index > Link.getExpressionCount().

Since:

12.0

setSourceExpression

void setSourceExpression(java.lang.String exprID)

Sets the expression which will be used to provide default properties for the merged dimension.

Parameters:

exprID - the unique identifier of the ReportExpression

Since:

12.0