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

All Known Subinterfaces:

IOverload

public interface IOverloadBase

This interface provides methods that allow you to manage overload objects within the BusinessObjects Enterprise Infrastructure.
Note: If a value is overloaded, its default value has been modified. For example, if the default value for a property is true, but the value is changed to false, the property is considered overloaded. Furthermore, if the value is set back to true, the property is still considered overloaded.

Field Summary

static java.lang.String

KIND The kind used to query for Overload objects.

Method Summary

int	getConnection() Returns the connection ID.
int	getMaxCostEstimation() Returns maximum cost estimation with no warning
int	getMaxExecutionTime() Returns the maximum execution time of a query.
int	getMaxLongTextObjectsSize() Returns the number of characters that are retrieved from a database.
int	getMaxResultSetSize() Returns the maximum number of rows that are returned by a query.
IObjectsOverload	getRestrictedObjects() Returns a collection of universe objects that are restricted from the given universe.
IRowsOverload	getRestrictedRows() Returns a collection of database table rows that are restricted from a given universe.
ITableMappingsOverload	getTableMappings() Returns a collection of table mappings for a given universe.
int	getUniverse() Returns the universe ID that applies to this overload object.
boolean	isComplexOperandsAllowed() Returns true if complex operands are allowed
boolean	isComplexOperandsAllowedOverloaded() Returns true if allowing complex operands is overloaded
boolean	isCostEstimationWarningEnabled() Returns true if cost estimation warning is enabled
boolean	isCostEstimationWarningOverloaded() Returns true if cost estimation warning is overloaded
boolean	isLimitExecutionTimeEnabled() Returns a boolean that indicates whether limiting the execution time has been enabled.
boolean	isLimitExecutionTimeOverloaded() Returns a boolean that indicates whether the execution time for a query has been overloaded.
boolean	isLimitLongTextObjectsSizeEnabled() Returns a boolean that indicates whether a limitation has been set on the size of long text objects.
boolean	isLimitLongTextObjectsSizeOverloaded() Returns a boolean that indicates whether the size of long text objects has been overloaded.
boolean	isLimitResultSetSizeEnabled() Returns a boolean that indicates whether limiting the result size has been enabled.
boolean	isLimitResultSetSizeOverloaded() Returns a boolean that indicates whether the result set size has been overloaded.
boolean	isMultipleContextSelectionAllowed() Returns a boolean that indicates whether allowing the selection of multiple contexts has been enabled.
boolean	isMultipleContextSelectionAllowedOverloaded() Returns a boolean that indicates whether allowing the selection of multiple contexts has been overloaded.
boolean	isMultipleSQLStatementsEachContextAllowed() Returns a boolean that indicates whether permission to use multiple SQL statements for each context has been enabled.
boolean	isMultipleSQLStatementsEachContextAllowedOverloaded() Returns a boolean that indicates whether allowing multiple SQL statements for each context has been overloaded.
boolean	isMultipleSQLStatementsEachMeasureAllowed() Returns a boolean that indicates whether permission to use multiple SQL statements for each measure has been enabled.
boolean	isMultipleSQLStatementsEachMeasureAllowedOverloaded() Returns a boolean that indicates whether permission to use multiple SQL statements for each measure has been overloaded.
boolean	isPreventCartesianProduct() Returns a boolean that indicates whether generating a cartesian product is prohibited.
boolean	isPreventCartesianProductOverloaded() Returns a boolean that indicates whether generating a cartesian product has been overloaded.
boolean	isSubQueriesAllowed() Returns true if subqueries are allowed
boolean	isSubQueriesAllowedOverloaded() Returns true if allowing subqueries is overloaded
boolean	isUnionIntersectMinusAllowed() Returns a boolean that indicates whether allowing the use of set operators (union, intersect, and minus) in SQL queries has been enabled.
boolean	isUnionIntersectMinusAllowedOverloaded() Returns a boolean that indicates whether allowing set operators in an SQL query has been overloaded.
void	setComplexOperandsAllowed(boolean bAllow) Sets the value for SI_ALLOW_COMPLEXOPERANDS.
void	setComplexOperandsAllowedOverloaded(boolean bOverload) Sets whether allowing complex operands is overloaded or not
void	setConnection(int id) sets the connection ID.
void	setCostEstimationWarningEnabled(boolean bEnable) Sets the value for SI_LIMIT_COSTESTIMATION.
void	setCostEstimationWarningOverloaded(boolean bOverload) Sets whether cost estimation warning is overloaded or not
void	setLimitExecutionTimeEnabled(boolean bEnable) Sets a boolean that indicates whether limiting the execution time has been enabled.
void	setLimitExecutionTimeOverloaded(boolean bOverload) Sets a boolean that indicates whether the default value for the execution time of a query has been overloaded.
void	setLimitLongTextObjectsSizeEnabled(boolean bEnable) Sets a boolean that indicates whether limiting the size of long text objects has been enabled.
void	setLimitLongTextObjectsSizeOverloaded(boolean bOverload) Sets a boolean that indicates whether the size of long text objects has been overloaded.
void	setLimitResultSetSizeEnabled(boolean bEnable) Sets a boolean that indicates whether limiting the result set size has been enabled.
void	setLimitResultSetSizeOverloaded(boolean bOverload) Sets a boolean that indicates whether the result set size has been overloaded.
void	setMaxCostEstimation(int maxEstimate) Sets maximum cost estimation with no warning
void	setMaxExecutionTime(int maxExecTime) Sets the maximum execution time of a query.
void	setMaxLongTextObjectsSize(int maxSize) Sets the number of characters that are retrieved from a database.
void	setMaxResultSetSize(int maxResultSize) Sets the maximum number of rows that are returned by a query.
void	setMultipleContextSelectionAllowed(boolean bAllow) Sets a boolean that indicates whether allowing the selection of multiple contexts has been enabled.
void	setMultipleContextSelectionAllowedOverloaded(boolean bOverload) Sets a boolean that indicates whether allowing the selection of multiple contexts has been overloaded.
void	setMultipleSQLStatementsEachContextAllowed(boolean bAllow) Sets a boolean that indicates whether permission to use of multiple SQL statements for each context has been enabled.
void	setMultipleSQLStatementsEachContextAllowedOverloaded(boolean bOverload) Sets a boolean that indicates whether permission to use multiple SQL statements for each context has been overloaded.
void	setMultipleSQLStatementsEachMeasureAllowed(boolean bAllow) Sets a boolean that indicates whether permission to use multiple SQL statements for each measure has been enabled.
void	setMultipleSQLStatementsEachMeasureAllowedOverloaded(boolean bOverload) Sets a boolean that indicates whether permission to use multiple SQL statements for each measure has been overloaded.
void	setPreventCartesianProduct(boolean bPrevent) Sets a boolean that indicates whether generating a cartesian product is prohibited.
void	setPreventCartesianProductOverloaded(boolean bOverload) Sets a boolean that indicates whether generating a cartesian product has been overloaded.
void	setSubQueriesAllowed(boolean bAllow) Sets the value for SI_ALLOW_SUBQUERIES.
void	setSubQueriesAllowedOverloaded(boolean bOverload) Sets whether allowing subqueries is overloaded or not
void	setUnionIntersectMinusAllowed(boolean bAllow) Sets a boolean that indicates whether allowing the use of set operators (union, intersect, and minus) in SQL queries has been enabled.
void	setUnionIntersectMinusAllowedOverloaded(boolean bOverload) Sets a boolean that indicates whether the size of long text objects has been overloaded.
void	setUniverse(int id) Sets the universe ID that applies to this overload object.

Field Detail

KIND

static final java.lang.String KIND

The kind used to query for Overload objects.

See Also:

Constant Field Values

Method Detail

getUniverse

int getUniverse()
                throws SDKException

Returns the universe ID that applies to this overload object.

Returns:

An int that represents the unique ID of the universe object.

Throws:

SDKException - Throws an exception if property is not found

setUniverse

void setUniverse(int id)

Sets the universe ID that applies to this overload object.

Parameters:

id - An int that specifies the universe ID.

getConnection

int getConnection()

Returns the connection ID.

A universe is identified by its name and database connection. This property identifies the database connection of the universe that is associated with this overload object.

Returns:

An int that represents the connection ID.

setConnection

void setConnection(int id)

sets the connection ID.

A universe is identified by its name and database connection. This property identifies the database connection of the universe that is associated with this overload object.

Parameters:

id - An int that specifies the connection ID.

isLimitResultSetSizeOverloaded

boolean isLimitResultSetSizeOverloaded()

Returns a boolean that indicates whether the result set size has been overloaded.

The default values for the query limit with respect to the result set size are:

• The property is set to true which indicates that the result set size will be limited. This information is managed by the isLimitResultSetSizeEnabled and the setLimitResultSetSizeEnabled.
• The result set size has been limited to 5000 rows. This information is managed by the getMaxResultSetSize and the setMaxResultSetSize.

Note: Ensure that this property returns true before you check the value for isLimitResultSetSizeEnabled.

Returns:

true if the result set size has been overloaded, and false otherwise.

See Also:

setLimitResultSetSizeOverloaded, setLimitResultSetSizeEnabled, isLimitResultSetSizeEnabled, getMaxResultSetSize, setMaxResultSetSize

setLimitResultSetSizeOverloaded

void setLimitResultSetSizeOverloaded(boolean bOverload)

Sets a boolean that indicates whether the result set size has been overloaded.

The default values for the query limit with respect to the result set size are:

• The property is set to true which indicates that the result set size will be limited to a certain number of rows. This information is managed by the isLimitResultSetSizeEnabled and the setLimitResultSetSizeEnabled.
• The result set size has been limited to 5000 rows. This information is managed by the getMaxResultSetSize and the setMaxResultSetSize.

Parameters:

bOverload - A boolean that specifies whether the result set size has been overloaded.

See Also:

isLimitResultSetSizeOverloaded, setLimitResultSetSizeEnabled, isLimitResultSetSizeEnabled, getMaxResultSetSize, setMaxResultSetSize

isLimitResultSetSizeEnabled

boolean isLimitResultSetSizeEnabled()
                                    throws SDKException

Returns a boolean that indicates whether limiting the result size has been enabled.

• The default value is true. This indicates that the result set size will be limited to a certain number of rows. Use the setLimitResultSetSizeEnabled to enable or disable this property.
• The default number of rows that are returned by a query is set to 5000. Use the setMaxResultSetSize to modify the number of rows returned by a query.

Note: Ensure that the isLimitResultSetSizeOverloaded returns true before you check the value returned by this method.

Returns:

trueif the result set size has been limited, and false otherwise.

Throws:

SDKException - Throws an exception if property is not found

See Also:

setLimitResultSetSizeEnabled, isLimitResultSetSizeOverloaded, setLimitResultSetSizeOverloaded, getMaxResultSetSize, setMaxResultSetSize

setLimitResultSetSizeEnabled

void setLimitResultSetSizeEnabled(boolean bEnable)

Sets a boolean that indicates whether limiting the result set size has been enabled.

Use this method to overload the SI_LIMIT_RESULTSETSIZE property.

Parameters:

bEnable - A boolean that specifies whether the property has been enabled.

See Also:

isLimitResultSetSizeEnabled, isLimitResultSetSizeOverloaded, setLimitResultSetSizeOverloaded, getMaxResultSetSize, setMaxResultSetSize

getMaxResultSetSize

int getMaxResultSetSize()
                        throws SDKException

Returns the maximum number of rows that are returned by a query.

The default value for the query limit is 5000 rows.

For this property to have an affect on the number of rows that a query can retrieve from the data source, the setLimitResultSetSizeEnabled must be set to true.

Returns:

An int which indicates the maximum number of rows that will be returned by a query.

Throws:

SDKException - Throws an exception if property is not found

See Also:

setMaxResultSetSize, isLimitResultSetSizeOverloaded, setLimitResultSetSizeOverloaded, isLimitResultSetSizeEnabled, setLimitResultSetSizeEnabled

setMaxResultSetSize

void setMaxResultSetSize(int maxResultSize)

Sets the maximum number of rows that are returned by a query.

For this property to have an affect on the number of rows that a query can retrieve from the database, the setLimitResultSetSizeEnabled must be set to true. Use this method to overload the SI_RESULTSETSIZE_VALUE property.

Note: This property allows you to specify the maximum number of rows that a query can retrieve from a database. When the query reaches this limit, it stops; however, the end user can still retrieve the partial results.

Parameters:

maxResultSize - The maximum result set size as an int.

See Also:

getMaxResultSetSize, isLimitResultSetSizeOverloaded, setLimitResultSetSizeOverloaded, isLimitResultSetSizeEnabled, setLimitResultSetSizeEnabled

isLimitExecutionTimeOverloaded

boolean isLimitExecutionTimeOverloaded()

Returns a boolean that indicates whether the execution time for a query has been overloaded.

The default values for the query limit with respect to execution time are:

• The property is set to true which indicates that the execution time will be limited. This information is managed by isLimitExecutionTimeEnabled and setLimitExecutionTimeEnabled.
• The execution time has been limited to 10 minutes. This information is managed by getMaxExecutionTime and setMaxExecutionTime.

Note: Ensure that this property returns true before you check the value for sLimitExecutionTimeEnabled.

Returns:

true if the execution time has been overloaded, and false otherwise.

See Also:

setLimitExecutionTimeOverloaded, isLimitExecutionTimeEnabled, setLimitExecutionTimeEnabled, getMaxExecutionTime, setMaxExecutionTime

setLimitExecutionTimeOverloaded

void setLimitExecutionTimeOverloaded(boolean bOverload)

Sets a boolean that indicates whether the default value for the execution time of a query has been overloaded.

The default values for the query limit with respect to execution time are:

• The property is set to true which indicates that the execution time will be limited. This information is managed by isLimitExecutionTimeEnabled and setLimitExecutionTimeEnabled.
• The execution time has been limited to 10 minutes. This information is managed by getMaxExecutionTime and setMaxExecutionTime.

Parameters:

bOverload - A boolean that indicates whether the execution time has been overloaded.

See Also:

isLimitExecutionTimeOverloaded, isLimitExecutionTimeEnabled, setLimitExecutionTimeEnabled, getMaxExecutionTime, setMaxExecutionTime

isLimitExecutionTimeEnabled

boolean isLimitExecutionTimeEnabled()
                                    throws SDKException

Returns a boolean that indicates whether limiting the execution time has been enabled.

• The default value is true. This indicates that the execution time will be limited to a certain time. Use the setLimitExecutionTimeEnabled to enable or disable this property.
• The default execution time imit for a query is set to 10 minutes. Use the setMaxExecutionTime to modify the time.

Note: Ensure that the isLimitResultSetSizeOverloaded returns true before you check the value returned by this method.

Returns:

true if the execution time has been limited, and false otherwise.

Throws:

SDKException - Throws an exception if property is not found

See Also:

setLimitExecutionTimeEnabled, isLimitExecutionTimeOverloaded, setLimitExecutionTimeOverloaded, getMaxExecutionTime, setMaxExecutionTime

setLimitExecutionTimeEnabled

void setLimitExecutionTimeEnabled(boolean bEnable)

Sets a boolean that indicates whether limiting the execution time has been enabled.

Use this method to overload the SI_LIMIT_EXECUTIONTIME property.

Parameters:

bEnable - A boolean that specifies whether the property has been enabled.

See Also:

isLimitExecutionTimeEnabled, isLimitExecutionTimeOverloaded, setLimitExecutionTimeOverloaded, getMaxExecutionTime, setMaxExecutionTime

getMaxExecutionTime

int getMaxExecutionTime()
                        throws SDKException

Returns the maximum execution time of a query.

The default value for the query limit is 10 minutes.

For this property to have an affect on the execution time of a query, the setLimitExecutionTimeEnabled must be set to true.

Returns:

An int which indicates the maximum execution time for a query.

Throws:

SDKException - Throws an exception if property is not found

See Also:

setMaxExecutionTime, isLimitExecutionTimeEnabled, setLimitExecutionTimeEnabled, isLimitExecutionTimeOverloaded, setLimitExecutionTimeOverloaded

setMaxExecutionTime

void setMaxExecutionTime(int maxExecTime)
                         throws SDKException

Sets the maximum execution time of a query.

For this property to have an affect on the execution time of a query, the setLimitExecutionTimeEnabled must be set to true. Use this method to overload the SI_EXECUTIONTIME_VALUE property.

Note: This property allows you to specify the maximum time (in minutes) that a query can execute before it expires. When the execution time has expired, it stops; however, the partial result is returned.

Parameters:

maxExecTime - An int which specifies the maximum execution time.

Throws:

SDKException - Throws an exception if property is not found

See Also:

getMaxExecutionTime, isLimitExecutionTimeEnabled, setLimitExecutionTimeEnabled, isLimitExecutionTimeOverloaded, setLimitExecutionTimeOverloaded

isLimitLongTextObjectsSizeOverloaded

boolean isLimitLongTextObjectsSizeOverloaded()

Returns a boolean that indicates whether the size of long text objects has been overloaded.

The default values for the query limit with respect to long text object sizes are:

• The property is set to true which indicates that the object size will be limited. This information is managed by the sLimitLongTextObjectsSizeEnabled and the setLimitLongTextObjectsSizeEnabled.
• The long text object size has been limited to 1000 characters. This information is managed by the getMaxLongTextObjectsSize and the setMaxLongTextObjectsSize.

Note: Ensure that this property returns true before you check the value for isLimitLongTextObjectsSizeEnabled.

Returns:

true if the text object size has been overloaded, and false otherwise.

See Also:

setLimitLongTextObjectsSizeOverloaded, isLimitLongTextObjectsSizeEnabled, setLimitLongTextObjectsSizeEnabled, getMaxLongTextObjectsSize, setMaxLongTextObjectsSize

setLimitLongTextObjectsSizeOverloaded

void setLimitLongTextObjectsSizeOverloaded(boolean bOverload)

Sets a boolean that indicates whether the size of long text objects has been overloaded.

The default values for the query limit with respect to long text object sizes are:

• The property is set to true which indicates that the object size will be limited. This information is managed by the isLimitLongTextObjectsSizeEnabled and the setLimitLongTextObjectsSizeEnabled.
• The long text object size has been limited to 1000 characters. This information is managed by the getMaxLongTextObjectsSize and the setMaxLongTextObjectsSize.

Parameters:

bOverload - A boolean that indicates whether the object size has been overloaded.

isLimitLongTextObjectsSizeEnabled

boolean isLimitLongTextObjectsSizeEnabled()
                                          throws SDKException

Returns a boolean that indicates whether a limitation has been set on the size of long text objects.

• The default value is true. This indicates that the size of long text objects will be limited to a certain number of characters. Use the setLimitLongTextObjectsSizeEnabled to enable or disable this property.
• The default size for long text objects is set to 1000 characters. Use the setMaxLongTextObjectsSize to modify the size.

Note: Ensure that the isLimitLongTextObjectsSizeOverloaded returns true before you check the value returned by this method.

Returns:

true if the long text object size has been limited, and false otherwise.

Throws:

SDKException - Throws an exception if property is not found

setLimitLongTextObjectsSizeEnabled

void setLimitLongTextObjectsSizeEnabled(boolean bEnable)

Sets a boolean that indicates whether limiting the size of long text objects has been enabled.

Use this method to overload the SI_LIMIT_LONGTEXTOBJECTSIZE property.

Parameters:

bEnable - A boolean that specifies whether the property has been enabled.

See Also:

isLimitLongTextObjectsSizeEnabled, isLimitLongTextObjectsSizeOverloaded, setLimitLongTextObjectsSizeOverloaded, getMaxLongTextObjectsSize, setMaxLongTextObjectsSize

getMaxLongTextObjectsSize

int getMaxLongTextObjectsSize()
                              throws SDKException

Returns the number of characters that are retrieved from a database.

The default value for the query limit is 1000 characters.

For this property to have an affect on the execution time of a query, the setLimitLongTextObjectsSizeEnabled must be set to true.

Returns:

An int which indicates the maximum number of characters retrieved for a query.

Throws:

SDKException - Throws an exception if property is not found

See Also:

setMaxLongTextObjectsSize, isLimitLongTextObjectsSizeEnabled, setLimitLongTextObjectsSizeEnabled, isLimitLongTextObjectsSizeOverloaded, setLimitLongTextObjectsSizeOverloaded

setMaxLongTextObjectsSize

void setMaxLongTextObjectsSize(int maxSize)
                               throws SDKException

Sets the number of characters that are retrieved from a database.

For this property to have an affect on the number of characters retrieved from a database, the setLimitLongTextObjectsSizeEnabled must be set to true. Use this method to overload the SI_LONGTEXTOBJECTSIZE_VALUE property.

Note: This property allows you to specify the maximum number of characters that a user can retrieve from the database. This number depends on the RDBMS which contains the data. A long text object can contain up to 32,000 characters and take up to 4 GB of disk space.

Parameters:

maxSize - An int which specifies the maximum number of characters that can be retrieved from a database for a single query.

Throws:

SDKException - Throws an exception if property is not found

See Also:

getMaxLongTextObjectsSize, isLimitLongTextObjectsSizeEnabled, setLimitLongTextObjectsSizeEnabled, isLimitLongTextObjectsSizeOverloaded, setLimitLongTextObjectsSizeOverloaded

isUnionIntersectMinusAllowedOverloaded

boolean isUnionIntersectMinusAllowedOverloaded()

Returns a boolean that indicates whether allowing set operators in an SQL query has been overloaded.

The default value for an SQL query option with respect to the use of set operators (union, intersect, and minus) is:

• The property is set to true which indicates that set operators are allowed to be used in a SQL query. This information is managed by the isUnionIntersectMinusAllowed and the setUnionIntersectMinusAllowed

Note: Ensure that this property returns true before you check the value for isUnionIntersectMinusAllowed.

Returns:

true if the property has been overloaded, and false otherwise.

See Also:

setUnionIntersectMinusAllowedOverloaded, isUnionIntersectMinusAllowed, setUnionIntersectMinusAllowed

setUnionIntersectMinusAllowedOverloaded

void setUnionIntersectMinusAllowedOverloaded(boolean bOverload)

Sets a boolean that indicates whether the size of long text objects has been overloaded.

The default value for an SQL query option with respect to the use of set operators (union, intersect, and minus) is:

• The property is set to true which indicates that set operators are allowed to be used in a SQL query. This information is managed by the isUnionIntersectMinusAllowed and the setUnionIntersectMinusAllowed

Parameters:

bOverload - A boolean that indicates whether the property has been overloaded.

See Also:

isUnionIntersectMinusAllowedOverloaded, isUnionIntersectMinusAllowed, setUnionIntersectMinusAllowed

isUnionIntersectMinusAllowed

boolean isUnionIntersectMinusAllowed()
                                     throws SDKException

Returns a boolean that indicates whether allowing the use of set operators (union, intersect, and minus) in SQL queries has been enabled.

• The default value is true. This indicates that the use of set operators in a SQL query is permitted. Use the setUnionIntersectMinusAllowed to enable or disable this property.

Note: Ensure that the isUnionIntersectMinusAllowedOverloaded returns true before you check the value returned by this method.

Returns:

true if the use of set operators in SQL queries are allowed, and false otherwise.

Throws:

SDKException - Throws an exception if property is not found

setUnionIntersectMinusAllowed

void setUnionIntersectMinusAllowed(boolean bAllow)

Sets a boolean that indicates whether allowing the use of set operators (union, intersect, and minus) in SQL queries has been enabled.

Use this method to overload the SI_ALLOW_UNIONINTERSECTMINUS property.

Note: If this property is set to true end users are able to combine queries using data set operators (union, intersect, and minus) to obtain one set of results.

Parameters:

bAllow - A boolean that indicates whether the use of set operators in a SQL query is permitted.

See Also:

isUnionIntersectMinusAllowed, isUnionIntersectMinusAllowedOverloaded, setUnionIntersectMinusAllowedOverloaded

isMultipleSQLStatementsEachContextAllowedOverloaded

boolean isMultipleSQLStatementsEachContextAllowedOverloaded()

Returns a boolean that indicates whether allowing multiple SQL statements for each context has been overloaded.

The default value for a SQL generation option with respect to the use of multiple SQL statements for each context is:

• The property is set to true which indicates that a query can be executed, with objects that belong to different joins, to generate two distinct sets of results simultaneously. This information is managed by the isMultipleSQLStatementsEachContextAllowed and the setMultipleSQLStatementsEachContextAllowed

Note: Ensure that this property returns true before you check the value for isMultipleSQLStatementsEachContextAllowed.

Returns:

true if allowing multiple SQL statements for each context has been overloaded, and false otherwise.

See Also:

setMultipleSQLStatementsEachContextAllowedOverloaded, isMultipleSQLStatementsEachContextAllowed, setMultipleSQLStatementsEachContextAllowed

setMultipleSQLStatementsEachContextAllowedOverloaded

void setMultipleSQLStatementsEachContextAllowedOverloaded(boolean bOverload)

Sets a boolean that indicates whether permission to use multiple SQL statements for each context has been overloaded.

The default value for a SQL generation option with respect to the use of multiple SQL statements for each context is:

• The property is set to true which indicates that a query can be executed, with objects that belong to different joins, to generate two distinct sets of results simultaneously. This information is managed by the isMultipleSQLStatementsEachContextAllowed and the setMultipleSQLStatementsEachContextAllowed

Parameters:

bOverload - A boolean that indicates whether the property has been overloaded.

See Also:

isMultipleSQLStatementsEachContextAllowedOverloaded, isMultipleSQLStatementsEachContextAllowed, setMultipleSQLStatementsEachContextAllowed

isMultipleSQLStatementsEachContextAllowed

boolean isMultipleSQLStatementsEachContextAllowed()
                                                  throws SDKException

Returns a boolean that indicates whether permission to use multiple SQL statements for each context has been enabled.

• The default value is true. This indicates that the use of multiple SQL statements for each context is permitted. Use the setMultipleSQLStatementsEachContextAllowed to enable or disable this property.

Note: Ensure that the isMultipleSQLStatementsEachContextAllowedOverloaded returns true before you check the value returned by this method.

Returns:

true if the use of multiple SQL statements for each context is permitted, and false otherwise.

Throws:

SDKException - Throws an exception if property is not found.

See Also:

setMultipleSQLStatementsEachContextAllowed, isMultipleSQLStatementsEachContextAllowedOverloaded, setMultipleSQLStatementsEachContextAllowedOverloaded

setMultipleSQLStatementsEachContextAllowed

void setMultipleSQLStatementsEachContextAllowed(boolean bAllow)

Sets a boolean that indicates whether permission to use of multiple SQL statements for each context has been enabled.

Use this method to overload the SI_ALLOW_MULTISQLSTATEMENTSEACHCONTEXT property.

Note: If this property is set to true end users can execute a query, with objects that belong to different joins, to generate two distinct sets of results simultaneously.

Parameters:

bAllow - A boolean that indicates whether the property has been enabled.

See Also:

isMultipleSQLStatementsEachContextAllowed, isMultipleSQLStatementsEachContextAllowedOverloaded, setMultipleSQLStatementsEachContextAllowedOverloaded

isMultipleSQLStatementsEachMeasureAllowedOverloaded

boolean isMultipleSQLStatementsEachMeasureAllowedOverloaded()

Returns a boolean that indicates whether permission to use multiple SQL statements for each measure has been overloaded.

The default value for a SQL generation option with respect to the use of multiple SQL statements for each measure is:

• The property is set to true which indicates that a query can be executed with measure objects that originate from different tables. This information is managed by the isMultipleSQLStatementsEachMeasureAllowed and the setMultipleSQLStatementsEachMeasureAllowed

Note: Ensure that this property returns true before you check the value for isMultipleSQLStatementsEachMeasureAllowed.

Returns:

true if allowing multiple SQL statements for each measuer has been overloaded, and false otherwise.

See Also:

setMultipleSQLStatementsEachMeasureAllowedOverloaded, isMultipleSQLStatementsEachMeasureAllowed, setMultipleSQLStatementsEachMeasureAllowed

setMultipleSQLStatementsEachMeasureAllowedOverloaded

void setMultipleSQLStatementsEachMeasureAllowedOverloaded(boolean bOverload)

Sets a boolean that indicates whether permission to use multiple SQL statements for each measure has been overloaded.

The default value for a SQL generation option with respect to the use of multiple SQL statements for each measure is:

• The property is set to true which indicates that a query can be executed with measure objects that originate from different tables. This information is managed by the isMultipleSQLStatementsEachMeasureAllowed and the setMultipleSQLStatementsEachMeasureAllowed

Parameters:

bOverload - A boolean that indicates whether the property has been overloaded.

See Also:

isMultipleSQLStatementsEachMeasureAllowedOverloaded, isMultipleSQLStatementsEachMeasureAllowed, setMultipleSQLStatementsEachMeasureAllowed

isMultipleSQLStatementsEachMeasureAllowed

boolean isMultipleSQLStatementsEachMeasureAllowed()
                                                  throws SDKException

Returns a boolean that indicates whether permission to use multiple SQL statements for each measure has been enabled.

• The default value is true. This indicates that the use of multiple SQL statements for each measure is permitted. Use the setMultipleSQLStatementsEachMeasureAllowed to enable or disable this property.

Note: Ensure that the isMultipleSQLStatementsEachMeasureAllowedOverloaded returns true before you check the value returned by this method.

Returns:

true if the use of multiple SQL statements for each measure is permitted, and false otherwise.

Throws:

SDKException - Throws an exception if property is not found.

See Also:

setMultipleSQLStatementsEachMeasureAllowed, isMultipleSQLStatementsEachMeasureAllowedOverloaded, setMultipleSQLStatementsEachMeasureAllowedOverloaded

setMultipleSQLStatementsEachMeasureAllowed

void setMultipleSQLStatementsEachMeasureAllowed(boolean bAllow)

Sets a boolean that indicates whether permission to use multiple SQL statements for each measure has been enabled.

Use this method to overload the SI_ALLOW_MULTISQLSTATEMENTSEACHMEASURE property.

Note: If this property is set to true end users can execute a query with measure objects that originate from different tables.

Parameters:

bAllow - A boolean that indicates whether the property has been enabled.

See Also:

isMultipleSQLStatementsEachMeasureAllowed, isMultipleSQLStatementsEachMeasureAllowedOverloaded, setMultipleSQLStatementsEachMeasureAllowedOverloaded

isMultipleContextSelectionAllowedOverloaded

boolean isMultipleContextSelectionAllowedOverloaded()

Returns a boolean that indicates whether allowing the selection of multiple contexts has been overloaded.

The default value for a SQL generation option with respect to the use of multiple contexts is:

• The property is set to false which indicates that a query cannot be executed along different paths within a loop, and generate two different sets of results simultaneously. This information is managed by the isMultipleContextSelectionAllowed and the setMultipleContextSelectionAllowed

Note: Ensure that this property returns true before you check the value for isMultipleContextSelectionAllowed.

Returns:

true if allowing the selection of multiple contexts has been overloaded, and false otherwise.

See Also:

setMultipleContextSelectionAllowedOverloaded, isMultipleContextSelectionAllowed, setMultipleContextSelectionAllowed

setMultipleContextSelectionAllowedOverloaded

void setMultipleContextSelectionAllowedOverloaded(boolean bOverload)

Sets a boolean that indicates whether allowing the selection of multiple contexts has been overloaded.

The default value for a SQL generation option with respect to the use of multiple contexts is:

• The property is set to false which indicates that a query cannot be executed along different paths within a loop, and generate two different sets of results simultaneously. This information is managed by the isMultipleContextSelectionAllowed and the setMultipleContextSelectionAllowed

Parameters:

bOverload - A boolean that indicates whether the property has been overloaded.

See Also:

isMultipleContextSelectionAllowedOverloaded, isMultipleContextSelectionAllowed, setMultipleContextSelectionAllowed

isMultipleContextSelectionAllowed

boolean isMultipleContextSelectionAllowed()
                                          throws SDKException

Returns a boolean that indicates whether allowing the selection of multiple contexts has been enabled.

• The default value is false. This indicates that a query cannot be executed along different paths within a loop, and generate two different sets of results simultaneously. Use the setMultipleContextSelectionAllowed to enable or disable this property.

Note: Ensure that the isMultipleContextSelectionAllowedOverloaded returns true before you check the value returned by this method.

Returns:

true if the selection of multiple contexts is permitted, and false otherwise.

Throws:

SDKException - Throws an exception if property is not found.

See Also:

setMultipleContextSelectionAllowed, isMultipleContextSelectionAllowedOverloaded, setMultipleContextSelectionAllowedOverloaded

setMultipleContextSelectionAllowed

void setMultipleContextSelectionAllowed(boolean bAllow)

Sets a boolean that indicates whether allowing the selection of multiple contexts has been enabled.

Use this method to overload the SI_ALLOW_MULTICONTEXTSELECTION property.

Note: If this property is set to true end users can execute a query along different paths within a loop, and generate two different sets of results simultaneously..

Parameters:

bAllow - A boolean that indicates whether the property has been enabled.

See Also:

isMultipleContextSelectionAllowed, isMultipleContextSelectionAllowedOverloaded, setMultipleContextSelectionAllowedOverloaded

isPreventCartesianProductOverloaded

boolean isPreventCartesianProductOverloaded()

Returns a boolean that indicates whether generating a cartesian product has been overloaded.

The default value for the SQL generation option with respect to a cartesian product is:

• The property is set to false which indicates cartesian products are allowed but that a warning is generated prior to the query being executed. This information is managed by the isPreventCartesianProduct and the setPreventCartesianProduct.

Note: Ensure that this property returns true before you check the value for isPreventCartesianProduct.

Returns:

true if the property has been overloaded, and false otherwise.

See Also:

setPreventCartesianProductOverloaded, isPreventCartesianProduct, setPreventCartesianProduct

setPreventCartesianProductOverloaded

void setPreventCartesianProductOverloaded(boolean bOverload)

Sets a boolean that indicates whether generating a cartesian product has been overloaded.

The default value for the SQL generation option with respect to a cartesian product is:

• The property is set to false which indicates that cartesian products are allowed but that a warning is generated prior to the query being executed. This information is managed by the isPreventCartesianProduct and the setPreventCartesianProduct.

Parameters:

bOverload - A boolean that indicates whether the property has been overloaded.

See Also:

isPreventCartesianProductOverloaded, isPreventCartesianProduct, setPreventCartesianProduct

isPreventCartesianProduct

boolean isPreventCartesianProduct()
                                  throws SDKException

Returns a boolean that indicates whether generating a cartesian product is prohibited.

• The default value is false. This indicates that cartesian products are allowed but that a warning is generated prior to the query being executed. Use the setPreventCartesianProduct to enable or disable this property.

Note: Ensure that the isPreventCartesianProductOverloaded returns true before checking the value returned by this method.

Returns:

true if cartesian products are prohibited, and false otherwise.

Throws:

SDKException - Throws an exception if property is not found

See Also:

isPreventCartesianProductOverloaded, setPreventCartesianProductOverloaded, setPreventCartesianProduct

setPreventCartesianProduct

void setPreventCartesianProduct(boolean bPrevent)

Sets a boolean that indicates whether generating a cartesian product is prohibited.

Use this method to overload the SI_PREVENT_CARTESIAN_PRODUCT property.

Note: If this property is set to false, it allows a cartesian product. A cartesian product is defined as a situation in which a query includes two or more tables that are not linked by a join. If executed, this query retrieves all possible combinations between each table, and may lead to inaccurate results.

Parameters:

bPrevent - true specifies that cartesian products are prohibited, and false permits cartesian products, but requires that a warning be issued before the query is executed.

See Also:

isPreventCartesianProductOverloaded, setPreventCartesianProductOverloaded, isPreventCartesianProduct

getRestrictedObjects

IObjectsOverload getRestrictedObjects()

Returns a collection of universe objects that are restricted from the given universe.

Returns:

A IObjectsOverload collection.

See Also:

IObjectsOverload, IObjectOverload

getRestrictedRows

IRowsOverload getRestrictedRows()

Returns a collection of database table rows that are restricted from a given universe.

Returns:

A IRowsOverload collection.

See Also:

IRowsOverload, IRowOverload

getTableMappings

ITableMappingsOverload getTableMappings()

Returns a collection of table mappings for a given universe.

Returns:

A ITableMappingsOverload collection.

See Also:

ITableMappingsOverload, ITableMappingOverload

isCostEstimationWarningOverloaded

boolean isCostEstimationWarningOverloaded()

Returns true if cost estimation warning is overloaded

Returns:

whether the cost estimation warning is overloaded as a boolean.

setCostEstimationWarningOverloaded

void setCostEstimationWarningOverloaded(boolean bOverload)

Sets whether cost estimation warning is overloaded or not

Parameters:

bOverload - true to overload cost estimation warning, false otherwise.

isCostEstimationWarningEnabled

boolean isCostEstimationWarningEnabled()
                                       throws SDKException

Returns true if cost estimation warning is enabled

Returns:

whether the cost estimation warning is enabled as a boolean.

Throws:

SDKException

setCostEstimationWarningEnabled

void setCostEstimationWarningEnabled(boolean bEnable)

Sets the value for SI_LIMIT_COSTESTIMATION.

Parameters:

bEnable - true to enable warning when cost estimation exceeds some value, false otherwise.

getMaxCostEstimation

int getMaxCostEstimation()
                         throws SDKException

Returns maximum cost estimation with no warning

Returns:

maximum cost estimation with no warning as an int.

Throws:

SDKException

setMaxCostEstimation

void setMaxCostEstimation(int maxEstimate)
                          throws SDKException

Sets maximum cost estimation with no warning

Parameters:

maxEstimate - The maximum cost estimation with no warningas an int.

Throws:

SDKException

isSubQueriesAllowedOverloaded

boolean isSubQueriesAllowedOverloaded()

Returns true if allowing subqueries is overloaded

Returns:

whether allowing subqueries is overloaded as a boolean.

setSubQueriesAllowedOverloaded

void setSubQueriesAllowedOverloaded(boolean bOverload)

Sets whether allowing subqueries is overloaded or not

Parameters:

bOverload - true to overload allowing subqueries, false otherwise.

isSubQueriesAllowed

boolean isSubQueriesAllowed()
                            throws SDKException

Returns true if subqueries are allowed

Returns:

whether subqueries are allowed as a boolean.

Throws:

SDKException

setSubQueriesAllowed

void setSubQueriesAllowed(boolean bAllow)

Sets the value for SI_ALLOW_SUBQUERIES.

Parameters:

bAllow - true to allow subqueries, false otherwise.

isComplexOperandsAllowedOverloaded

boolean isComplexOperandsAllowedOverloaded()

Returns true if allowing complex operands is overloaded

Returns:

whether allowing complex operands is overloaded as a boolean.

setComplexOperandsAllowedOverloaded

void setComplexOperandsAllowedOverloaded(boolean bOverload)

Sets whether allowing complex operands is overloaded or not

Parameters:

bOverload - true to overload allowing complex operands, false otherwise.

isComplexOperandsAllowed

boolean isComplexOperandsAllowed()
                                 throws SDKException

Returns true if complex operands are allowed

Returns:

whether complex operands are allowed as a boolean.

Throws:

SDKException

setComplexOperandsAllowed

void setComplexOperandsAllowed(boolean bAllow)

Sets the value for SI_ALLOW_COMPLEXOPERANDS.

Parameters:

bAllow - true to allow complex operands, false otherwise.