com.businessobjects.sdk.plugin.desktop.overload
Interface IRowOverload

public interface IRowOverload

Contains six methods that allow you to identify which database row should be restricted.

Represents a row in a database table that cannot be accessed in a universe by certain groups or users. This interface contains methods that allow you to identify which database row should be restricted.

Note: Restrictions on a group are inherited by its members. If a user inherits an object restriction from the parent group, that restriction cannot be changed for the user, while the user remains a member of that group. Furthermore, if a user is a member of more than one group, then the sum of object restrictions for each group is applied to the user.

Method Summary

int	getRestrictedTableID() Returns the database table ID.
java.lang.String	getRestrictedTableName() Returns the database table name.
java.lang.String	getWhereClause() Returns the SQL Where clause.
void	setRestrictedTableID(int tableID) Sets the database table ID.
void	setRestrictedTableName(java.lang.String tableName) Sets the database table name.
void	setWhereClause(java.lang.String whereClause) Sets the SQL Where clause.

Method Detail

getRestrictedTableID

public int getRestrictedTableID()

Returns the database table ID.

Note: Use this method to identify the database table ID that contains the row(s) that will be restricted from the final view of a universe or Web Intelligence document.

Returns:

An int that identifies the table ID; returns -1 if the object does not exist.

setRestrictedTableID

public void setRestrictedTableID(int tableID)

Sets the database table ID.

Note: Use this method to specify the database table ID that contains the row(s) that will be restricted from the final view of a universe or Web Intelligence document.

Parameters:

tableID - An int that specifies the table ID.

getRestrictedTableName

public java.lang.String getRestrictedTableName()

Returns the database table name.

Note: Use this method to identify the database table name that contains the row(s) that will be restricted from the final view of a universe or Web Intelligence document.

Returns:

A String that identifies the table name; returns null if object does not exist.

setRestrictedTableName

public void setRestrictedTableName(java.lang.String tableName)

Sets the database table name.

Note: Use this method to specify the database table name that contains the row(s) that will be restricted from the final view of a universe or Web Intelligence document.

Parameters:

tableName - A String that specifies the table name.

getWhereClause

public java.lang.String getWhereClause()
                                throws SDKException

Returns the SQL Where clause.

Note: Use this method to identify the condition that restricts the rows in the database table.

Returns:

A String that identifies the Where clause. This string is appended to the query to restrict certain rows from being accessed.

Throws:

SDKException - Throws exception if property is not found

setWhereClause

public void setWhereClause(java.lang.String whereClause)

Sets the SQL Where clause.

Note: Use this method to specify the condition that restricts the rows in the database table.

Parameters:

whereClause - A String that identifies the Where clause. This string is appended to the query to restrict certain rows from being accessed.