com.sap.sl.sdk.authoring.datafoundation

Interface SQLQueryLov

All Superinterfaces:

Identifiable, Inheritable, Lov, Nameable

public interface SQLQueryLov
extends Lov

A representation of the model object 'SQL Query Lov'.

This interface represents a list of values that is based on a custom SQL expression. Each value is defined as a result of this query. You can access this SQL expression through the getSQLExpression() and setSQLExpression(String) methods.

To instantiate a list of values based on a custom SQL query, you can use:

• BusinessLayerFactory.createSQLQueryLov(String, BusinessLayer)
• DataFoundationFactory.createSQLQueryLov(String, DataFoundation)

The columns describing the values returned by this expression can be retrieved with the getColumns() method.

In the information design tool, the user builds the query in the SQL Expression Editor. See the Information Design Tool User Guide for more information.

The following features are supported:

• Query Execution Timeout Enabled
• Query Execution Timeout
• Max Row Count Enabled
• Max Row Count
• SQL Expression

Method Summary

Modifier and Type	Method and Description
java.util.List<SQLQueryLovColumn>	getColumns() Returns the columns of a SQLQueryLov object.
int	getMaxRowCount() Returns the value of the 'Max Row Count' attribute.
int	getQueryExecutionTimeout() Returns the value of the 'Query Execution Timeout' attribute.
java.lang.String	getSQLExpression() Returns the value of the 'SQL Expression' attribute.
boolean	isMaxRowCountEnabled() Returns the value of the 'Max Row Count Enabled' attribute.
boolean	isQueryExecutionTimeoutEnabled() Returns the value of the 'Query Execution Timeout Enabled' attribute.
void	setMaxRowCount(int value) Sets the value of the 'Max Row Count' attribute.
void	setMaxRowCountEnabled(boolean value) Sets the value of the 'Max Row Count Enabled' attribute.
void	setQueryExecutionTimeout(int value) Sets the value of the 'Query Execution Timeout' attribute.
void	setQueryExecutionTimeoutEnabled(boolean value) Sets the value of the 'Query Execution Timeout Enabled' attribute.
void	setSQLExpression(java.lang.String value) Sets the value of the 'SQL Expression' attribute.

Methods inherited from interface com.sap.sl.sdk.authoring.datafoundation.Lov

getDescription, isHidden, setDescription, setHidden

Methods inherited from interface com.sap.sl.sdk.authoring.commons.Identifiable

getIdentifier

Methods inherited from interface com.sap.sl.sdk.authoring.commons.Nameable

getName, setName

Methods inherited from interface com.sap.sl.sdk.authoring.commons.Inheritable

getInheritedData

Method Detail

isQueryExecutionTimeoutEnabled

boolean isQueryExecutionTimeoutEnabled()

Returns the value of the 'Query Execution Timeout Enabled' attribute. The default value is "false".

Tells if there is a limit to the time in seconds that the query runs.

Returns:

the value of the 'Query Execution Timeout Enabled' attribute.

See Also:

setQueryExecutionTimeoutEnabled(boolean)

setQueryExecutionTimeoutEnabled

void setQueryExecutionTimeoutEnabled(boolean value)

Sets the value of the 'Query Execution Timeout Enabled' attribute.

There is a limit to the time in seconds that the query runs, if value is true.

Parameters:

value - the new value of the 'Query Execution Timeout Enabled' attribute.

See Also:

isQueryExecutionTimeoutEnabled()

getQueryExecutionTimeout

int getQueryExecutionTimeout()

Returns the value of the 'Query Execution Timeout' attribute. The default value is "100".

This is the limit to the time in seconds that the query runs.

Returns:

the value of the 'Query Execution Timeout' attribute.

See Also:

setQueryExecutionTimeout(int)

setQueryExecutionTimeout

void setQueryExecutionTimeout(int value)

Sets the value of the 'Query Execution Timeout' attribute.

This is the limit to the time in seconds that the query runs.

Parameters:

value - the new value of the 'Query Execution Timeout' attribute.

See Also:

getQueryExecutionTimeout()

isMaxRowCountEnabled

boolean isMaxRowCountEnabled()

Returns the value of the 'Max Row Count Enabled' attribute. The default value is "false".

Tells if there is a maximum number of rows to be returned by the query.

Returns:

the value of the 'Max Row Count Enabled' attribute.

See Also:

setMaxRowCountEnabled(boolean)

setMaxRowCountEnabled

void setMaxRowCountEnabled(boolean value)

Sets the value of the 'Max Row Count Enabled' attribute.

There is a maximum number of rows to be returned by the list of values query, if value is true.

Parameters:

value - the new value of the 'Max Row Count Enabled' attribute.

See Also:

isMaxRowCountEnabled()

getMaxRowCount

int getMaxRowCount()

Returns the value of the 'Max Row Count' attribute. The default value is "500".

This is the maximum number of rows to be returned by the query.

Returns:

the value of the 'Max Row Count' attribute.

See Also:

setMaxRowCount(int)

setMaxRowCount

void setMaxRowCount(int value)

Sets the value of the 'Max Row Count' attribute.

This is the maximum number of rows to be returned by the query.

Parameters:

value - the new value of the 'Max Row Count' attribute.

See Also:

getMaxRowCount()

getSQLExpression

java.lang.String getSQLExpression()

Returns the value of the 'SQL Expression' attribute. The default value is "".

This is the SQL expression from which the list of values is built.

Returns:

the value of the 'SQL Expression' attribute.

See Also:

setSQLExpression(String)

setSQLExpression

void setSQLExpression(java.lang.String value)

Sets the value of the 'SQL Expression' attribute.

This is the SQL expression from which the list of values is built.

Parameters:

value - the new value of the 'SQL Expression' attribute.

See Also:

getSQLExpression()

getColumns

java.util.List<SQLQueryLovColumn> getColumns()

Returns the columns of a SQLQueryLov object.

These columns are computed when the data foundation or business layer is loaded or saved. They can be also computed explicitly with DataFoundationService.detectLovColumns(SQLQueryLov) and BusinessLayerService.detectLovColumns(SQLQueryLov) methods.

Returns:

A list of SQLQueryLovColumn objects