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

All Superinterfaces:
Customizable, Nameable, QueryScriptCustomizable, SlResource
All Known Subinterfaces:
OlapBusinessLayer, RelationalBusinessLayer

public interface BusinessLayer
extends SlResource, Nameable, Customizable, QueryScriptCustomizable

A representation of the 'Business Layer' model object.

This interface provides a series of methods used to set the query limits, options, and comments attached to a business layer. See the Information Design Tool User Guide for more information.

The following features are supported:


Method Summary
 BlItem getBlItem(java.lang.String path, boolean failed)
           
 java.util.List<BusinessLayerView> getBusinessLayerViews()
          Returns the value of the 'Business Layer Views' containment reference list.
 java.lang.String getComments()
          Returns the value of the 'Comments' attribute.
 java.util.List<UniverseReference> getCoreUniverseReferences()
          Returns the value of the 'Core Universe References' containment reference list.
 int getCostEstimateExcessTime()
          Returns the value of the 'Cost Estimate Excess Time' attribute.
 java.util.List<NavigationPath> getCustomNavigationPaths()
          Returns the value of the 'Custom Navigation Paths' containment reference list.
 java.lang.String getDescription()
          Returns the value of the 'Description' attribute.
 java.util.List<Lov> getLovs()
          Returns the value of the 'Lovs' containment reference list.
 NavigationPathMode getNavigationPathMode()
          Returns the value of the 'Navigation Path Mode' attribute.
 java.util.List<Parameter> getParameters()
          Returns the value of the 'Parameters' containment reference list.
 long getQueryExecutionTimeLimit()
          Returns the value of the 'Query Execution Time Limit' attribute.
 long getResultSetSizeLimit()
          Returns the value of the 'Result Set Size Limit' attribute.
 RootFolder getRootFolder()
          Returns the value of the 'Root Folder' containment reference.
 boolean isComplexOperandsInFilterAllowed()
          Returns the value of the 'Complex Operands In Filter Allowed' attribute.
 boolean isCostEstimateWarningEnabled()
          Returns the value of the 'Cost Estimate Warning Enabled' attribute.
 boolean isMasterViewHidden()
          Returns the value of the 'Master View Hidden' attribute.
 boolean isMultipleSQLStatementsPerMeasureAllowed()
          Returns the value of the 'Multiple SQL Statements Per Measure Allowed' attribute.
 boolean isQueryExecutionTimeLimited()
          Returns the value of the 'Query Execution Time Limited' attribute.
 boolean isQueryStrippingAllowed()
          Returns the value of the 'Query Stripping Allowed' attribute.
 boolean isResultSetSizeLimited()
          Returns the value of the 'Result Set Size Limited' attribute.
 boolean isUseOfCombinedQueriesAllowed()
          Returns the value of the 'Use Of Combined Queries Allowed' attribute.
 boolean isUseOfSubqueriesAllowed()
          Returns the value of the 'Use Of Subqueries Allowed' attribute.
 void setComments(java.lang.String value)
          Sets the value of the 'Comments' attribute.
 void setComplexOperandsInFilterAllowed(boolean value)
          Sets the value of the 'Complex Operands In Filter Allowed' attribute.
 void setCostEstimateExcessTime(int value)
          Sets the value of the 'Cost Estimate Excess Time' attribute.
 void setCostEstimateWarningEnabled(boolean value)
          Sets the value of the 'Cost Estimate Warning Enabled' attribute.
 void setDescription(java.lang.String value)
          Sets the value of the 'Description' attribute.
 void setMasterViewHidden(boolean value)
          Sets the value of the 'Master View Hidden' attribute.
 void setMultipleSQLStatementsPerMeasureAllowed(boolean value)
          Sets the value of the 'Multiple SQL Statements Per Measure Allowed' attribute.
 void setNavigationPathMode(NavigationPathMode value)
          Sets the value of the 'Navigation Path Mode' attribute.
 void setQueryExecutionTimeLimit(long value)
          Sets the value of the 'Query Execution Time Limit' attribute.
 void setQueryExecutionTimeLimited(boolean value)
          Sets the value of the 'Query Execution Time Limited' attribute.
 void setQueryStrippingAllowed(boolean value)
          Sets the value of the 'Query Stripping Allowed' attribute.
 void setResultSetSizeLimit(long value)
          Sets the value of the 'Result Set Size Limit' attribute.
 void setResultSetSizeLimited(boolean value)
          Sets the value of the 'Result Set Size Limited' attribute.
 void setUseOfCombinedQueriesAllowed(boolean value)
          Sets the value of the 'Use Of Combined Queries Allowed' attribute.
 void setUseOfSubqueriesAllowed(boolean value)
          Sets the value of the 'Use Of Subqueries Allowed' attribute.
 
Methods inherited from interface com.sap.sl.sdk.authoring.commons.SlResource
getResourcePath
 
Methods inherited from interface com.sap.sl.sdk.authoring.commons.Nameable
getName, setName
 
Methods inherited from interface com.sap.sl.sdk.authoring.commons.Customizable
getCustomProperties
 
Methods inherited from interface com.sap.sl.sdk.authoring.commons.QueryScriptCustomizable
getQueryScriptProperties, resetQueryScriptProperties
 

Method Detail

getDescription

java.lang.String getDescription()
Returns the value of the 'Description' attribute. The default value is "".

This string represents the description of the business layer.

Returns:
the value of the 'Description' attribute.
See Also:
setDescription(String)

setDescription

void setDescription(java.lang.String value)
Sets the value of the 'Description' attribute.

This string represents the description of the business layer.

Parameters:
value - the new value of the 'Description' attribute.
See Also:
getDescription()

getRootFolder

RootFolder getRootFolder()
Returns the value of the 'Root Folder' containment reference. It is bidirectional and its opposite is 'Business Layer'.

This string represents the root folder that contains the business layer.

Returns:
the value of the 'Root Folder' containment reference.
See Also:
RootFolder.getBusinessLayer()

getBusinessLayerViews

java.util.List<BusinessLayerView> getBusinessLayerViews()
Returns the value of the 'Business Layer Views' containment reference list. The list contents are of type BusinessLayerView.

This is the list of the business layer views of a business layer.

Returns:
the value of the 'Business Layer Views' containment reference list.

getLovs

java.util.List<Lov> getLovs()
Returns the value of the 'Lovs' containment reference list. The list contents are of type Lov.

This is the list of lists of values attached to a business layer.

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

getParameters

java.util.List<Parameter> getParameters()
Returns the value of the 'Parameters' containment reference list. The list contents are of type Parameter.

This is the list of parameters attached to a business layer.

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

isMasterViewHidden

boolean isMasterViewHidden()
Returns the value of the 'Master View Hidden' attribute.

Tells if the master view is hidden in the business layer. It cannot be hidden if there is no other view.

Returns:
the value of the 'Master View Hidden' attribute.
See Also:
setMasterViewHidden(boolean)

setMasterViewHidden

void setMasterViewHidden(boolean value)
Sets the value of the 'Master View Hidden' attribute.

The master view is hidden if value is true.

Parameters:
value - the new value of the 'Master View Hidden' attribute.
See Also:
isMasterViewHidden()

isResultSetSizeLimited

boolean isResultSetSizeLimited()
Returns the value of the 'Result Set Size Limited' attribute. The default value is "true".

Tells if the number of rows returned in a query is limited.

Returns:
the value of the 'Result Set Size Limited' attribute.
See Also:
setResultSetSizeLimited(boolean)

setResultSetSizeLimited

void setResultSetSizeLimited(boolean value)
Sets the value of the 'Result Set Size Limited' attribute.

Sets a limit to the number of rows returned in a query if value is true.

Parameters:
value - the new value of the 'Result Set Size Limited' attribute.
See Also:
isResultSetSizeLimited()

getResultSetSizeLimit

long getResultSetSizeLimit()
Returns the value of the 'Result Set Size Limit' attribute. The default value is "5000".

This is the limit set to the number of rows returned in a query.

Returns:
the value of the 'Result Set Size Limit' attribute.
See Also:
setResultSetSizeLimit(long)

setResultSetSizeLimit

void setResultSetSizeLimit(long value)
Sets the value of the 'Result Set Size Limit' attribute.

This is the limit set to the number of rows returned in a query.

Parameters:
value - the new value of the 'Result Set Size Limit' attribute.
See Also:
getResultSetSizeLimit()

isQueryExecutionTimeLimited

boolean isQueryExecutionTimeLimited()
Returns the value of the 'Query Execution Time Limited' attribute. The default value is "true".

Tells if the time passed for query execution is limited.

Returns:
the value of the 'Query Execution Time Limited' attribute.
See Also:
setQueryExecutionTimeLimited(boolean)

setQueryExecutionTimeLimited

void setQueryExecutionTimeLimited(boolean value)
Sets the value of the 'Query Execution Time Limited' attribute.

Sets a limit to the time passed for query execution if value is true.

Parameters:
value - the new value of the 'Query Execution Time Limited' attribute.
See Also:
isQueryExecutionTimeLimited()

getQueryExecutionTimeLimit

long getQueryExecutionTimeLimit()
Returns the value of the 'Query Execution Time Limit' attribute. The default value is "600".

This is the limit set to the time passed for query execution in minutes.

Returns:
the value of the 'Query Execution Time Limit' attribute.
See Also:
setQueryExecutionTimeLimit(long)

setQueryExecutionTimeLimit

void setQueryExecutionTimeLimit(long value)
Sets the value of the 'Query Execution Time Limit' attribute.

This is the limit set to the time passed for query execution in minutes.

Parameters:
value - the new value of the 'Query Execution Time Limit' attribute.
See Also:
getQueryExecutionTimeLimit()

isUseOfSubqueriesAllowed

boolean isUseOfSubqueriesAllowed()
Returns the value of the 'Use Of Subqueries Allowed' attribute. The default value is "true".

Tells if subqueries can be used in queries.

Returns:
the value of the 'Use Of Subqueries Allowed' attribute.
See Also:
setUseOfSubqueriesAllowed(boolean)

setUseOfSubqueriesAllowed

void setUseOfSubqueriesAllowed(boolean value)
Sets the value of the 'Use Of Subqueries Allowed' attribute.

Allows the use of subqueries in queries if value is true.

Parameters:
value - the new value of the 'Use Of Subqueries Allowed' attribute.
See Also:
isUseOfSubqueriesAllowed()

isUseOfCombinedQueriesAllowed

boolean isUseOfCombinedQueriesAllowed()
Returns the value of the 'Use Of Combined Queries Allowed' attribute. The default value is "true".

Tells if queries can be combined using UNION, MINUS or INTERSECT to obtain one result set.

Returns:
the value of the 'Use Of Combined Queries Allowed' attribute.
See Also:
setUseOfCombinedQueriesAllowed(boolean)

setUseOfCombinedQueriesAllowed

void setUseOfCombinedQueriesAllowed(boolean value)
Sets the value of the 'Use Of Combined Queries Allowed' attribute.

Allows the use of combined queries if value is true.

Parameters:
value - the new value of the 'Use Of Combined Queries Allowed' attribute.
See Also:
isUseOfCombinedQueriesAllowed()

isQueryStrippingAllowed

boolean isQueryStrippingAllowed()
Returns the value of the 'Query Stripping Allowed' attribute. The default value is "false".

Tells if the query stripping is allowed for relational universes built from the business layer.

Returns:
the value of the 'Query Stripping Allowed' attribute.
See Also:
setQueryStrippingAllowed(boolean)

setQueryStrippingAllowed

void setQueryStrippingAllowed(boolean value)
Sets the value of the 'Query Stripping Allowed' attribute.

Allows query stripping if value is true.

Parameters:
value - the new value of the 'Query Stripping Allowed' attribute.
See Also:
isQueryStrippingAllowed()

isComplexOperandsInFilterAllowed

boolean isComplexOperandsInFilterAllowed()
Returns the value of the 'Complex Operands In Filter Allowed' attribute. The default value is "true".

Tells if the use of complex operands is allowed in filters.

Returns:
the value of the 'Complex Operands In Filter Allowed' attribute.
See Also:
setComplexOperandsInFilterAllowed(boolean)

setComplexOperandsInFilterAllowed

void setComplexOperandsInFilterAllowed(boolean value)
Sets the value of the 'Complex Operands In Filter Allowed' attribute.

Allows the use of complex operands in filters if value is true.

Parameters:
value - the new value of the 'Complex Operands In Filter Allowed' attribute.
See Also:
isComplexOperandsInFilterAllowed()

isMultipleSQLStatementsPerMeasureAllowed

boolean isMultipleSQLStatementsPerMeasureAllowed()
Returns the value of the 'Multiple SQL Statements Per Measure Allowed' attribute. The default value is "true".

Tells if multiple SQL statements are generated for each measure or group of measures belonging to a different fact table.

Returns:
the value of the 'Multiple SQL Statements Per Measure Allowed' attribute.
See Also:
setMultipleSQLStatementsPerMeasureAllowed(boolean)

setMultipleSQLStatementsPerMeasureAllowed

void setMultipleSQLStatementsPerMeasureAllowed(boolean value)
Sets the value of the 'Multiple SQL Statements Per Measure Allowed' attribute.

Allows the use of multiple SQL statements for each measure if value is true.

Parameters:
value - the new value of the 'Multiple SQL Statements Per Measure Allowed' attribute.
See Also:
isMultipleSQLStatementsPerMeasureAllowed()

isCostEstimateWarningEnabled

boolean isCostEstimateWarningEnabled()
Returns the value of the 'Cost Estimate Warning Enabled' attribute. The default value is "false".

Tells if there is a warning message when cost estimate is exceeded.

Returns:
the value of the 'Cost Estimate Warning Enabled' attribute.
See Also:
setCostEstimateWarningEnabled(boolean)

setCostEstimateWarningEnabled

void setCostEstimateWarningEnabled(boolean value)
Sets the value of the 'Cost Estimate Warning Enabled' attribute.

If value is true, there is a warning message when cost estimate is exceeded.

Parameters:
value - the new value of the 'Cost Estimate Warning Enabled' attribute.
See Also:
isCostEstimateWarningEnabled()

getCostEstimateExcessTime

int getCostEstimateExcessTime()
Returns the value of the 'Cost Estimate Excess Time' attribute. The default value is "300".

This is the number of minutes exceeded by the cost estimate, from which a warning message is displayed. Is only related to Teradata connections.

Returns:
the value of the 'Cost Estimate Excess Time' attribute.
See Also:
setCostEstimateExcessTime(int)

setCostEstimateExcessTime

void setCostEstimateExcessTime(int value)
Sets the value of the 'Cost Estimate Excess Time' attribute.

This is the number of minutes exceeded by the cost estimate, from which a warning message is displayed. Is only related to Teradata connections.

Parameters:
value - the new value of the 'Cost Estimate Excess Time' attribute.
See Also:
getCostEstimateExcessTime()

getCustomNavigationPaths

java.util.List<NavigationPath> getCustomNavigationPaths()
Returns the value of the 'Custom Navigation Paths' containment reference list. The list contents are of type NavigationPath.

This is the list of navigation paths the end-user has created to drill business objects in reporting tools.

Returns:
the value of the 'Custom Navigation Paths' containment reference list.

getCoreUniverseReferences

java.util.List<UniverseReference> getCoreUniverseReferences()
Returns the value of the 'Core Universe References' containment reference list. The list contents are of type UniverseReference.

This list presents the core universes referenced by the business layer.

This list is empty if no core universe is linked to the business layer.

Returns:
the value of the 'Core Universe References' containment reference list.

getComments

java.lang.String getComments()
Returns the value of the 'Comments' attribute.

This string represents the comments attached to the business layer.

Returns:
the value of the 'Comments' attribute.
See Also:
setComments(String)

setComments

void setComments(java.lang.String value)
Sets the value of the 'Comments' attribute.

This string represents the comments attached to the business layer.

Parameters:
value - the new value of the 'Comments' attribute.
See Also:
getComments()

getNavigationPathMode

NavigationPathMode getNavigationPathMode()
Returns the value of the 'Navigation Path Mode' attribute. The default value is "Default".

This represents the navigation path mode used (default or custom.)

Returns:
the value of the 'Navigation Path Mode' attribute.
See Also:
NavigationPathMode, setNavigationPathMode(NavigationPathMode)

setNavigationPathMode

void setNavigationPathMode(NavigationPathMode value)
Sets the value of the 'Navigation Path Mode' attribute.

This represents the navigation path mode used (default or custom.)

Parameters:
value - the new value of the 'Navigation Path Mode' attribute.
See Also:
NavigationPathMode, getNavigationPathMode()

getBlItem

BlItem getBlItem(java.lang.String path,
                 boolean failed)



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