com.businessobjects.rebean.wi
Interface SQLSelectStatement

All Superinterfaces:

SQLNode, TreeNode

public interface SQLSelectStatement
extends SQLNode

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

The SQLSelectStatement interface is a representation of an SQL SELECT statement generated by the SQLDataProvider from a user query.

Use the SQLSelectStatement interfaces to customize SQL generated by Web Intelligence from a users query specification.

Note: Business Objects recommends that customized SQL is validated using SQLDataProvider.validateSQL() before saving the new SQL statement by calling SQLDataProvider.changeSQL().

Since:

11.5

See Also:

SQLDataProvider, DataProvider.getCombinedQueries(), SQLDataProvider.getSQLContainer(), SQLContainer, SQLNode

Method Summary

java.lang.String	getID() Returns a unique identifier for this SQLSelectStatement instance.
java.lang.String	getSQL() Returns the SQL contained in this SQLSelectStatement.
boolean	isCustomSQL() Returns true if this SQLSelectStatement contains customized SQL.
void	setSQL(java.lang.String newStatement) This method is used to update the contents of the SQLSelectStatement with SQL customized by the current user.

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

getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

getID

java.lang.String getID()

Returns a unique identifier for this SQLSelectStatement instance.

Returns:

The SQLSelectStatement identifier.

isCustomSQL

boolean isCustomSQL()

Returns true if this SQLSelectStatement contains customized SQL. Returns false if the SQL has been generated by Web Intelligence.

Note: This method returns true only when the DocumentInstance containing the Query has been saved.

Returns:

Returns false when the SQL contained in this instance has been generated by Web Intelligence, true when a user has customized the SQL and saved the document.

See Also:

DocumentInstance, Query

getSQL

java.lang.String getSQL()

Returns the SQL contained in this SQLSelectStatement.

Returns:

The SQL contained in this SQLSelectStatement.

setSQL

void setSQL(java.lang.String newStatement)

This method is used to update the contents of the SQLSelectStatement with SQL customized by the current user.

Note: Business Objects recommends that customized SQL is validated using SQLDataProvider.validateSQL() before saving the document or running the query.

Note: The SELECT clause must match the objects already present in the Query. FROM and WHERE clause are modifiable if the user has sufficient rights.

Parameters:

newStatement - A customized SQL statement.