com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.statisticalkeyfigure

Class StatisticalKeyFigureText

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity<StatisticalKeyFigureText>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.statisticalkeyfigure.StatisticalKeyFigureText

public class StatisticalKeyFigureText
extends VdmEntity<StatisticalKeyFigureText>

API Statistical Key Figure Text

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatisticalKeyFigureText.StatisticalKeyFigureTextBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static StatisticalKeyFigureTextSelectable	ALL_FIELDS Selector for all available fields of StatisticalKeyFigureText.
static StatisticalKeyFigureTextField<String>	CONTROLLING_AREA Use with available fluent helpers to apply the ControllingArea field to query operations.
static StatisticalKeyFigureTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static StatisticalKeyFigureTextField<String>	STATISTICAL_KEY_FIGURE Use with available fluent helpers to apply the StatisticalKeyFigure field to query operations.
static StatisticalKeyFigureTextField<String>	STATISTICAL_KEY_FIGURE_NAME Use with available fluent helpers to apply the StatisticalKeyFigureName field to query operations.
static StatisticalKeyFigureTextLink<StatisticalKeyFigure>	TO_STATISTICAL_KEY_FIGURE Use with available fluent helpers to apply the to_StatisticalKeyFigure navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
StatisticalKeyFigureText()
StatisticalKeyFigureText(String language, String controllingArea, String statisticalKeyFigure, String statisticalKeyFigureName, ErpConfigContext erpConfigContext, StatisticalKeyFigure toStatisticalKeyFigure)

Method Summary

Modifier and Type	Method and Description
static StatisticalKeyFigureText.StatisticalKeyFigureTextBuilder	builder()
boolean	equals(Object o)
StatisticalKeyFigure	fetchStatisticalKeyFigure() Fetches the StatisticalKeyFigure entity (one to one) associated with this entity.
static <T> StatisticalKeyFigureTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getControllingArea() (Key Field) Constraints: Not nullable, Maximum length: 4
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2 - the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.
String	getStatisticalKeyFigure() (Key Field) Constraints: Not nullable, Maximum length: 6
String	getStatisticalKeyFigureName() Constraints: Not nullable, Maximum length: 40
StatisticalKeyFigure	getStatisticalKeyFigureOrFetch() Retrieval of associated StatisticalKeyFigure entity (one to one).
com.google.common.base.Optional<StatisticalKeyFigure>	getStatisticalKeyFigureOrNull() Retrieval of associated StatisticalKeyFigure entity (one to one).
Class<StatisticalKeyFigureText>	getType()
int	hashCode()
void	setControllingArea(String controllingArea) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2 - the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.
void	setStatisticalKeyFigure(StatisticalKeyFigure value) Overwrites the associated StatisticalKeyFigure entity for the loaded navigation property to_StatisticalKeyFigure.
void	setStatisticalKeyFigure(String value) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setStatisticalKeyFigureName(String statisticalKeyFigureName) Constraints: Not nullable, Maximum length: 40
String	toString()

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity

getVersionIdentifier, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final StatisticalKeyFigureTextSelectable ALL_FIELDS

Selector for all available fields of StatisticalKeyFigureText.

LANGUAGE

public static final StatisticalKeyFigureTextField<String> LANGUAGE

Use with available fluent helpers to apply the Language field to query operations.

CONTROLLING_AREA

public static final StatisticalKeyFigureTextField<String> CONTROLLING_AREA

Use with available fluent helpers to apply the ControllingArea field to query operations.

STATISTICAL_KEY_FIGURE

public static final StatisticalKeyFigureTextField<String> STATISTICAL_KEY_FIGURE

Use with available fluent helpers to apply the StatisticalKeyFigure field to query operations.

STATISTICAL_KEY_FIGURE_NAME

public static final StatisticalKeyFigureTextField<String> STATISTICAL_KEY_FIGURE_NAME

Use with available fluent helpers to apply the StatisticalKeyFigureName field to query operations.

TO_STATISTICAL_KEY_FIGURE

public static final StatisticalKeyFigureTextLink<StatisticalKeyFigure> TO_STATISTICAL_KEY_FIGURE

Use with available fluent helpers to apply the to_StatisticalKeyFigure navigation property to query operations.

Constructor Detail

StatisticalKeyFigureText

public StatisticalKeyFigureText()

StatisticalKeyFigureText

public StatisticalKeyFigureText(@Nullable
                                String language,
                                @Nullable
                                String controllingArea,
                                @Nullable
                                String statisticalKeyFigure,
                                @Nullable
                                String statisticalKeyFigureName,
                                @Nullable
                                ErpConfigContext erpConfigContext,
                                @Nullable
                                StatisticalKeyFigure toStatisticalKeyFigure)

Method Detail

getType

public Class<StatisticalKeyFigureText> getType()

Specified by:

getType in class VdmObject<StatisticalKeyFigureText>

Returns:

The class of this object.

field

public static <T> StatisticalKeyFigureTextField<T> field(String fieldName,
                                                         Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

Parameters:

fieldName - The name of the extension field as returned by the OData service.

fieldType - The Java type to use for the extension field when performing value comparisons.

Returns:

A representation of an extension field from this entity.

fetchStatisticalKeyFigure

public StatisticalKeyFigure fetchStatisticalKeyFigure()
                                               throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the StatisticalKeyFigure entity (one to one) associated with this entity. This corresponds to the OData navigation property to_StatisticalKeyFigure.

Please note: This method will not cache or persist the query results.

Returns:

The single associated StatisticalKeyFigure entity, or null if an entity is not associated.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

getStatisticalKeyFigureOrFetch

public StatisticalKeyFigure getStatisticalKeyFigureOrFetch()
                                                    throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated StatisticalKeyFigure entity (one to one).

If the navigation property to_StatisticalKeyFigure of a queried StatisticalKeyFigureText is operated lazily, an ODataException can be thrown in case of an OData query error.

Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

Returns:

List of associated StatisticalKeyFigure entity.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

getStatisticalKeyFigureOrNull

public com.google.common.base.Optional<StatisticalKeyFigure> getStatisticalKeyFigureOrNull()

Retrieval of associated StatisticalKeyFigure entity (one to one).

If the navigation property to_StatisticalKeyFigure for an entity StatisticalKeyFigureText has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_StatisticalKeyFigure is already loaded, the result will contain the StatisticalKeyFigure entity. If not, a null value state is returned.

setStatisticalKeyFigure

public void setStatisticalKeyFigure(StatisticalKeyFigure value)

Overwrites the associated StatisticalKeyFigure entity for the loaded navigation property to_StatisticalKeyFigure.

Parameters:

value - New StatisticalKeyFigure entity.

setStatisticalKeyFigure

public void setStatisticalKeyFigure(String value)

(Key Field) Constraints: Not nullable, Maximum length: 6

Parameters:

value - statisticalKeyFigure

builder

public static StatisticalKeyFigureText.StatisticalKeyFigureTextBuilder builder()

getLanguage

@Nullable
public String getLanguage()

(Key Field) Constraints: Not nullable, Maximum length: 2

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Returns:

The language key indicates

getControllingArea

@Nullable
public String getControllingArea()

(Key Field) Constraints: Not nullable, Maximum length: 4

Returns:

Controlling Area

getStatisticalKeyFigure

@Nullable
public String getStatisticalKeyFigure()

(Key Field) Constraints: Not nullable, Maximum length: 6

Returns:

Statistical Key Figure

getStatisticalKeyFigureName

@Nullable
public String getStatisticalKeyFigureName()

Constraints: Not nullable, Maximum length: 40

Returns:

Statistical Key Figure Name

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setLanguage

public void setLanguage(@Nullable
                        String language)

(Key Field) Constraints: Not nullable, Maximum length: 2

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Parameters:

language -

setControllingArea

public void setControllingArea(@Nullable
                               String controllingArea)

(Key Field) Constraints: Not nullable, Maximum length: 4

Parameters:

controllingArea -

setStatisticalKeyFigureName

public void setStatisticalKeyFigureName(@Nullable
                                        String statisticalKeyFigureName)

Constraints: Not nullable, Maximum length: 40

Parameters:

statisticalKeyFigureName -

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<StatisticalKeyFigureText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<StatisticalKeyFigureText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<StatisticalKeyFigureText>