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

All Superinterfaces:
BlItem, Customizable, Identifiable, Inheritable, Nameable
All Known Subinterfaces:
Attribute, Dimension, Measure

public interface BusinessObject
extends BlItem

A representation of the 'Business Object' model object.

Business objects are dimensions, measures and attributes.

This interface provides a series of methods to define some of the advanced properties of the business object:

See the Information Design Tool User Guide for more information.

The following features are supported:


Method Summary
 AccessLevel getAccessLevel()
          Returns the value of the 'Access Level' attribute.
 LovColumn getAssociatedLov()
          Returns the value of the 'Associated Lov' reference.
 Binding getBinding()
          Returns the value of the 'Binding' containment reference.
 DataType getDataType()
          Returns the value of the 'Data Type' attribute.
 DisplayFormat getDisplayFormat()
          Returns the value of the 'Display Format' reference.
 java.lang.String getLineage()
          Returns the value of the 'Lineage' attribute.
 java.lang.String getMapping()
          Returns the value of the 'Mapping' attribute.
 java.lang.String getSelect()
          Deprecated. 
 java.lang.String getTechnicalInformation()
          Returns the value of the 'Technical Information' attribute.
 java.lang.String getWhere()
          Deprecated. 
 boolean isAssociatedLovEnabled()
          Returns the value of the 'Associated Lov Enabled' attribute.
 boolean isUsableInConditions()
          Returns the value of the 'Usable In Conditions' attribute.
 boolean isUsableInResults()
          Returns the value of the 'Usable In Results' attribute.
 boolean isUsableInSort()
          Returns the value of the 'Usable In Sort' attribute.
 void setAccessLevel(AccessLevel value)
          Sets the value of the 'Access Level' attribute.
 void setAssociatedLov(LovColumn value)
          Sets the value of the 'Associated Lov' reference.
 void setAssociatedLovEnabled(boolean value)
          Sets the value of the 'Associated Lov Enabled' attribute.
 void setDataType(DataType value)
          Sets the value of the 'Data Type' attribute.
 void setLineage(java.lang.String value)
          Sets the value of the 'Lineage' attribute.
 void setMapping(java.lang.String value)
          Sets the value of the 'Mapping' attribute.
 void setSelect(java.lang.String value)
          Deprecated. 
 void setTechnicalInformation(java.lang.String value)
          Sets the value of the 'Technical Information' attribute.
 void setUsableInConditions(boolean value)
          Sets the value of the 'Usable In Conditions' attribute.
 void setUsableInResults(boolean value)
          Sets the value of the 'Usable In Results' attribute.
 void setUsableInSort(boolean value)
          Sets the value of the 'Usable In Sort' attribute.
 void setWhere(java.lang.String value)
          Deprecated. 
 
Methods inherited from interface com.sap.sl.sdk.authoring.businesslayer.BlItem
getDescription, getInheritedData, getParent, getPath, getState, setDescription, setState
 
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.Customizable
getCustomProperties
 

Method Detail

getSelect

@Deprecated
java.lang.String getSelect()
Deprecated. 

Use RelationalBinding.getSelect().

getBinding() allows you to retrieve a RelationalBinding.


setSelect

@Deprecated
void setSelect(java.lang.String value)
Deprecated. 

Use RelationalBinding.setSelect(String).

getBinding() allows you to retrieve a RelationalBinding.


getWhere

@Deprecated
java.lang.String getWhere()
Deprecated. 

Use RelationalBinding.getWhere().

getBinding() allows you to retrieve a RelationalBinding.


setWhere

@Deprecated
void setWhere(java.lang.String value)
Deprecated. 

Use RelationalBinding.setWhere(String).

getBinding() allows you to retrieve a RelationalBinding.


getAccessLevel

AccessLevel getAccessLevel()
Returns the value of the 'Access Level' attribute. The literals are from the enumeration AccessLevel.

This is the access level of a business object. You can assign the following access levels to an object:

Returns:
the value of the 'Access Level' attribute.
See Also:
AccessLevel, setAccessLevel(AccessLevel)

setAccessLevel

void setAccessLevel(AccessLevel value)
Sets the value of the 'Access Level' attribute.

This is the access level of a business object.

Parameters:
value - the new value of the 'Access Level' attribute.
See Also:
AccessLevel, getAccessLevel()

getBinding

Binding getBinding()
Returns the value of the 'Binding' containment reference.

Can be safely cast to RelationalBinding for RelationalBusinessLayer.

Returns:
the value of the 'Binding' containment reference.
Since:
14.1

getDataType

DataType getDataType()
Returns the value of the 'Data Type' attribute. The default value is "". The literals are from the enumeration DataType.

This is the data type of a business object.

Returns:
the value of the 'Data Type' attribute.
See Also:
DataType, setDataType(DataType)

setDataType

void setDataType(DataType value)
Sets the value of the 'Data Type' attribute.

This is the data type of a business object.

Parameters:
value - the new value of the 'Data Type' attribute.
See Also:
DataType, getDataType()

isUsableInResults

boolean isUsableInResults()
Returns the value of the 'Usable In Results' attribute. The default value is "true".

Tells if the business object can be used as a result object.

Returns:
the value of the 'Usable In Results' attribute.
See Also:
setUsableInResults(boolean)

setUsableInResults

void setUsableInResults(boolean value)
Sets the value of the 'Usable In Results' attribute.

Allows the use of the business object as result object if value is true.

Parameters:
value - the new value of the 'Usable In Results' attribute.
See Also:
isUsableInResults()

isUsableInConditions

boolean isUsableInConditions()
Returns the value of the 'Usable In Conditions' attribute. The default value is "true".

Tells if the business object can be used in filters.

Returns:
the value of the 'Usable In Conditions' attribute.
See Also:
setUsableInConditions(boolean)

setUsableInConditions

void setUsableInConditions(boolean value)
Sets the value of the 'Usable In Conditions' attribute.

Allows the use of the business object in filters if value is true.

Parameters:
value - the new value of the 'Usable In Conditions' attribute.
See Also:
isUsableInConditions()

isUsableInSort

boolean isUsableInSort()
Returns the value of the 'Usable In Sort' attribute. The default value is "true".

Tells if the business object can be used in sortings.

Returns:
the value of the 'Usable In Sort' attribute.
See Also:
setUsableInSort(boolean)

setUsableInSort

void setUsableInSort(boolean value)
Sets the value of the 'Usable In Sort' attribute.

Allows the use of the business object in sortings if value is true.

Parameters:
value - the new value of the 'Usable In Sort' attribute.
See Also:
isUsableInSort()

getAssociatedLov

LovColumn getAssociatedLov()
Returns the value of the 'Associated Lov' reference.

This is the column of a list of values associated with the business object of the business layer.

When a business object is created, a column of a list of values is associated with the object by default. The list of values is the one computed for this object.

Returns:
the value of the 'Associated Lov' reference.
See Also:
setAssociatedLov(LovColumn)

setAssociatedLov

void setAssociatedLov(LovColumn value)
Sets the value of the 'Associated Lov' reference.

This is the column of a list of values associated with the business object.

The column is one of the following:

Important: you can only associate a list of values defined in the business layer.

Parameters:
value - the new value of the 'Associated Lov' reference.
See Also:
getAssociatedLov()

isAssociatedLovEnabled

boolean isAssociatedLovEnabled()
Returns the value of the 'Associated Lov Enabled' attribute. The default value is "true".

Tells if a list of values can be associated with the business object.

Returns:
the value of the 'Associated Lov Enabled' attribute.
See Also:
setAssociatedLovEnabled(boolean)

setAssociatedLovEnabled

void setAssociatedLovEnabled(boolean value)
Sets the value of the 'Associated Lov Enabled' attribute.

A list of values can be associated with the business object, if value is true.

Parameters:
value - the new value of the 'Associated Lov Enabled' attribute.
See Also:
isAssociatedLovEnabled()

getDisplayFormat

DisplayFormat getDisplayFormat()
Returns the value of the 'Display Format' reference.

This is the display format of the data associated with the business object.

Returns:
the value of the 'Display Format' reference.

getTechnicalInformation

java.lang.String getTechnicalInformation()
Returns the value of the 'Technical Information' attribute. The default value is "".

The technical information is part of the source information of a business object. This is information about a column, for example the original database name of the concerned column for the object.

Returns:
the value of the 'Technical Information' attribute.
See Also:
setTechnicalInformation(String)

setTechnicalInformation

void setTechnicalInformation(java.lang.String value)
Sets the value of the 'Technical Information' attribute.

The technical information is part of the source information of a business object. This is information about a column, for example the original database name of the concerned column for the object.

Parameters:
value - the new value of the 'Technical Information' attribute.
See Also:
getTechnicalInformation()

getMapping

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

The mapping is part of the source information of a business object. This is the initial formula information describing how a column has been specified (used in Data Integrator), for example revenue = column calculated from several sources.

Returns:
the value of the 'Mapping' attribute.
See Also:
setMapping(String)

setMapping

void setMapping(java.lang.String value)
Sets the value of the 'Mapping' attribute.

The mapping is part of the source information of a business object. This is the initial formula information describing how a column has been specified (used in Data Integrator), for example revenue = column calculated from several sources.

Parameters:
value - the new value of the 'Mapping' attribute.
See Also:
getMapping()

getLineage

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

The lineage is part of the source information of a business object. This specifies the source columns for the formula used to calculate the column in the database.

Returns:
the value of the 'Lineage' attribute.
See Also:
setLineage(String)

setLineage

void setLineage(java.lang.String value)
Sets the value of the 'Lineage' attribute.

The lineage is part of the source information of a business object. This specifies the source columns for the formula used to calculate the column in the database.

Parameters:
value - the new value of the 'Lineage' attribute.
See Also:
getLineage()


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