com.sap.sl.sdk.authoring.businesslayer

Interface BusinessQueryLov

All Superinterfaces:

Identifiable, Inheritable, Lov, Nameable

public interface BusinessQueryLov
extends Lov

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

This interface represents a list of values that is based on a query built with business objects. Each value is defined as a result of this query.

You can create BusinessQueryLovs and also retrieve the query expression and edit it.

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

The following features are supported:

• Filter Forced Before Use
• Search In Database Allowed
• Expression

Method Summary

Modifier and Type	Method and Description
java.util.List<BusinessQueryLovColumn>	getColumns() Returns the columns of a BusinessQueryLov object.
java.lang.String	getExpression() Returns the value of the 'Expression' attribute.
boolean	isFilterForcedBeforeUse() Returns the value of the 'Filter Forced Before Use' attribute.
boolean	isSearchInDatabaseAllowed() Returns the value of the 'Search In Database Allowed' attribute.
void	setExpression(java.lang.String value) Sets the value of the 'Expression' attribute.
void	setFilterForcedBeforeUse(boolean value) Sets the value of the 'Filter Forced Before Use' attribute.
void	setSearchInDatabaseAllowed(boolean value) Sets the value of the 'Search In Database Allowed' attribute.
IStatus	validateExpression() Validates the query specification against its XSD and returns a status.

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

isFilterForcedBeforeUse

boolean isFilterForcedBeforeUse()

Returns the value of the 'Filter Forced Before Use' attribute. The default value is "false".

Tells if the user has to enter search criteria before getting filtered values for the list of values. Only the values that match the search criteria are returned in the list of values. Characters used to define the matching criteria are the following:

• * (asterisk) to match any number of characters, even zero character
• ? (question mark) to match exactly one character
• \ (backslash) to escape the next character allowing you to search for a wildcard character

Returns:

the value of the 'Filter Forced Before Use' attribute.

See Also:

setFilterForcedBeforeUse(boolean)

setFilterForcedBeforeUse

void setFilterForcedBeforeUse(boolean value)

Sets the value of the 'Filter Forced Before Use' attribute.

The user has to enter search criteria before getting filtered values for the list of values, if value is true. Only the values that match the search criteria are returned in the list of values. Characters used to define the matching criteria are the following:

• * (asterisk) to match any number of characters, even zero character
• ? (question mark) to match exactly one character
• \ (backslash) to escape the next character allowing you to search for a wildcard character

Note: When the business layer is saved, if setFilterForcedBeforeUse(true), then setSearchInDatabaseAllowed(true) is applied automatically.

Parameters:

value - the new value of the 'Filter Forced Before Use' attribute.

See Also:

isFilterForcedBeforeUse()

isSearchInDatabaseAllowed

boolean isSearchInDatabaseAllowed()

Returns the value of the 'Search In Database Allowed' attribute. The default value is "false".

Tells if the user is able to search for a value of the list of values in the database.

Returns:

the value of the 'Search In Database Allowed' attribute.

See Also:

setSearchInDatabaseAllowed(boolean)

setSearchInDatabaseAllowed

void setSearchInDatabaseAllowed(boolean value)

Sets the value of the 'Search In Database Allowed' attribute.

The user is able to search for a value of the list of values in the database, if value is true.

Parameters:

value - the new value of the 'Search In Database Allowed' attribute.

See Also:

isSearchInDatabaseAllowed()

getExpression

java.lang.String getExpression()

Returns the value of the 'Expression' attribute.

The query is a query specification in XML format.

Returns:

the value of the 'Expression' attribute.

See Also:

setExpression(String)

setExpression

void setExpression(java.lang.String value)

Sets the value of the 'Expression' attribute.

The query is a query specification in XML format.

Parameters:

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

See Also:

getExpression()

validateExpression

IStatus validateExpression()

Validates the query specification against its XSD and returns a status.

getColumns

java.util.List<BusinessQueryLovColumn> getColumns()

Returns the columns of a BusinessQueryLov object.

The list of BusinessQueryLovColumn objects is computed from the query. This list cannot be changed directly. A BusinessQueryLovColumn corresponds to a result object in the query.

Returns:

A list of BusinessQueryLovColumn objects