com.sap.sl.sdk.authoring.businesslayer
Interface BusinessHierarchicalLov

All Superinterfaces:
Identifiable, Inheritable, Lov, Nameable

public interface BusinessHierarchicalLov
extends Lov

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

This interface represents a list of values that is based on a custom hierarchy of objects in the business layer. The hierarchy is a level-based hierarchy where the business layer dimensions are the hierarchy levels. Each value of the list is built as a path in the hierarchy (value and ancestors).

Use BusinessLayerFactory.createBusinessHierarchicalLov(String, BusinessLayer) to instantiate a hierarchical list of values.

The following features are supported:


Method Summary
 java.util.List<BusinessHierarchicalLovColumn> getColumns()
          Returns the value of the 'Columns' containment reference list.
 int getMaxRowCount()
          Returns the value of the 'Max Row Count' attribute.
 int getQueryExecutionTimeout()
          Returns the value of the 'Query Execution Timeout' 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.
 
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 "0".

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 to the number of rows returned by the query that is using the list of values.

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 to the number of rows returned by the 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 "0".

This is the maximum number of rows to be returned by the query that is using the list of values.

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 that is using the list of values.

Parameters:
value - the new value of the 'Max Row Count' attribute.
See Also:
getMaxRowCount()

getColumns

java.util.List<BusinessHierarchicalLovColumn> getColumns()
Returns the value of the 'Columns' containment reference list. The list contents are of type BusinessHierarchicalLovColumn.

This is the list of columns for a list of values based on a custom hierarchy.

Returns:
the value of the 'Columns' containment reference list.


© Copyright 2016 SAP SE or an SAP affiliate company. All rights reserved.