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

Class StatisticalKeyFigure

java.lang.Object

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

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

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

public class StatisticalKeyFigure
extends VdmEntity<StatisticalKeyFigure>

API Statistical Key Figure

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatisticalKeyFigure.StatisticalKeyFigureBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static StatisticalKeyFigureSelectable	ALL_FIELDS Selector for all available fields of StatisticalKeyFigure.
static StatisticalKeyFigureField<String>	CONTROLLING_AREA Use with available fluent helpers to apply the ControllingArea field to query operations.
static StatisticalKeyFigureField<String>	STATISTICAL_KEY_FIGURE Use with available fluent helpers to apply the StatisticalKeyFigure field to query operations.
static StatisticalKeyFigureField<String>	STSTC_KEY_FIG_CATEGORY Use with available fluent helpers to apply the StstcKeyFigCategory field to query operations.
static StatisticalKeyFigureField<String>	STSTC_KEY_FIG_QUANTITY_UNIT Use with available fluent helpers to apply the StstcKeyFigQuantityUnit field to query operations.
static StatisticalKeyFigureLink<StatisticalKeyFigureText>	TO_TEXT Use with available fluent helpers to apply the to_Text navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
StatisticalKeyFigure()
StatisticalKeyFigure(String statisticalKeyFigure, String controllingArea, String ststcKeyFigQuantityUnit, String ststcKeyFigCategory, ErpConfigContext erpConfigContext, List<StatisticalKeyFigureText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(StatisticalKeyFigureText... entity) Adds elements to the list of associated StatisticalKeyFigureText entities.
static StatisticalKeyFigure.StatisticalKeyFigureBuilder	builder()
boolean	equals(Object o)
List<StatisticalKeyFigureText>	fetchText() Fetches the StatisticalKeyFigureText entities (one to many) associated with this entity.
static <T> StatisticalKeyFigureField<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	getStatisticalKeyFigure() (Key Field) Constraints: Not nullable, Maximum length: 6
String	getStstcKeyFigCategory() Constraints: Not nullable, Maximum length: 1 From the initial month for all subsequent months of the current fiscal year (Type 1 = fixed value)For the respective month and not carried forward to the subsequent months (Type 2 = totals value)The number of employees is entered as type 1 (fixed value) and the number of long-distance calls is entered as type 2 (totals value).To correct quantities after entering them as statistical key figures, cancel type 2 values by entering the value with a reversed +/- sign.
String	getStstcKeyFigQuantityUnit() Constraints: Not nullable, Maximum length: 3 The unit with which the statistical key figure is recorded in the database is defined in the master data and cannot be changed.
List<StatisticalKeyFigureText>	getTextOrFetch() Retrieval of associated StatisticalKeyFigureText entities (one to many).
com.google.common.base.Optional<List<StatisticalKeyFigureText>>	getTextOrNull() Retrieval of associated StatisticalKeyFigureText entities (one to many).
Class<StatisticalKeyFigure>	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	setStatisticalKeyFigure(String statisticalKeyFigure) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setStstcKeyFigCategory(String ststcKeyFigCategory) Constraints: Not nullable, Maximum length: 1 From the initial month for all subsequent months of the current fiscal year (Type 1 = fixed value)For the respective month and not carried forward to the subsequent months (Type 2 = totals value)The number of employees is entered as type 1 (fixed value) and the number of long-distance calls is entered as type 2 (totals value).To correct quantities after entering them as statistical key figures, cancel type 2 values by entering the value with a reversed +/- sign.
void	setStstcKeyFigQuantityUnit(String ststcKeyFigQuantityUnit) Constraints: Not nullable, Maximum length: 3 The unit with which the statistical key figure is recorded in the database is defined in the master data and cannot be changed.
void	setText(List<StatisticalKeyFigureText> value) Overwrites the list of associated StatisticalKeyFigureText entities for the loaded navigation property to_Text.
String	toString()

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 StatisticalKeyFigureSelectable ALL_FIELDS

Selector for all available fields of StatisticalKeyFigure.

STATISTICAL_KEY_FIGURE

public static final StatisticalKeyFigureField<String> STATISTICAL_KEY_FIGURE

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

CONTROLLING_AREA

public static final StatisticalKeyFigureField<String> CONTROLLING_AREA

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

STSTC_KEY_FIG_QUANTITY_UNIT

public static final StatisticalKeyFigureField<String> STSTC_KEY_FIG_QUANTITY_UNIT

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

STSTC_KEY_FIG_CATEGORY

public static final StatisticalKeyFigureField<String> STSTC_KEY_FIG_CATEGORY

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

TO_TEXT

public static final StatisticalKeyFigureLink<StatisticalKeyFigureText> TO_TEXT

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

Constructor Detail

StatisticalKeyFigure

public StatisticalKeyFigure()

StatisticalKeyFigure

public StatisticalKeyFigure(@Nullable
                            String statisticalKeyFigure,
                            @Nullable
                            String controllingArea,
                            @Nullable
                            String ststcKeyFigQuantityUnit,
                            @Nullable
                            String ststcKeyFigCategory,
                            @Nullable
                            ErpConfigContext erpConfigContext,
                            List<StatisticalKeyFigureText> toText)

Method Detail

getType

public Class<StatisticalKeyFigure> getType()

Specified by:

getType in class VdmObject<StatisticalKeyFigure>

Returns:

The class of this object.

field

public static <T> StatisticalKeyFigureField<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.

fetchText

public List<StatisticalKeyFigureText> fetchText()
                                         throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the StatisticalKeyFigureText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Text.

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

Returns:

List containing one or more associated StatisticalKeyFigureText entities. If no entities are associated then an empty list is returned.

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.

getTextOrFetch

public List<StatisticalKeyFigureText> getTextOrFetch()
                                              throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated StatisticalKeyFigureText entities (one to many).

If the navigation property to_Text of a queried StatisticalKeyFigure 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 StatisticalKeyFigureText entities.

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.

getTextOrNull

public com.google.common.base.Optional<List<StatisticalKeyFigureText>> getTextOrNull()

Retrieval of associated StatisticalKeyFigureText entities (one to many).

If the navigation property to_Text for an entity StatisticalKeyFigure 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_Text is already loaded, the result will contain the StatisticalKeyFigureText entities. If not, a null value state is returned.

setText

public void setText(@NonNull
                    List<StatisticalKeyFigureText> value)

Overwrites the list of associated StatisticalKeyFigureText entities for the loaded navigation property to_Text.

If the navigation property to_Text of a queried StatisticalKeyFigure 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.

Parameters:

value - List of StatisticalKeyFigureText entities.

addText

public void addText(StatisticalKeyFigureText... entity)

Adds elements to the list of associated StatisticalKeyFigureText entities.

If the navigation property to_Text of a queried StatisticalKeyFigure 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.

Parameters:

entity - Array of StatisticalKeyFigureText entities.

builder

public static StatisticalKeyFigure.StatisticalKeyFigureBuilder builder()

getStatisticalKeyFigure

@Nullable
public String getStatisticalKeyFigure()

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

Returns:

Statistical Key Figure

getControllingArea

@Nullable
public String getControllingArea()

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

Returns:

Controlling Area

getStstcKeyFigQuantityUnit

@Nullable
public String getStstcKeyFigQuantityUnit()

Constraints: Not nullable, Maximum length: 3

The unit with which the statistical key figure is recorded in the database is defined in the master data and cannot be changed.

Returns:

Unit of quantity or time with which the tracing factors of the statistical key figures are posted.

getStstcKeyFigCategory

@Nullable
public String getStstcKeyFigCategory()

Constraints: Not nullable, Maximum length: 1

From the initial month for all subsequent months of the current fiscal year (Type 1 = fixed value)For the respective month and not carried forward to the subsequent months (Type 2 = totals value)The number of employees is entered as type 1 (fixed value) and the number of long-distance calls is entered as type 2 (totals value).To correct quantities after entering them as statistical key figures, cancel type 2 values by entering the value with a reversed +/- sign. Then enter the correct value.To change key figures of type 1, enter a new fixed value. This value will then be valid for all subsequent periods until you enter new value.

Returns:

Field defining whether values are fixed in one of two ways:

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.

setStatisticalKeyFigure

public void setStatisticalKeyFigure(@Nullable
                                    String statisticalKeyFigure)

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

Parameters:

statisticalKeyFigure -

setControllingArea

public void setControllingArea(@Nullable
                               String controllingArea)

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

Parameters:

controllingArea -

setStstcKeyFigQuantityUnit

public void setStstcKeyFigQuantityUnit(@Nullable
                                       String ststcKeyFigQuantityUnit)

Constraints: Not nullable, Maximum length: 3

The unit with which the statistical key figure is recorded in the database is defined in the master data and cannot be changed.

Parameters:

ststcKeyFigQuantityUnit -

setStstcKeyFigCategory

public void setStstcKeyFigCategory(@Nullable
                                   String ststcKeyFigCategory)

Constraints: Not nullable, Maximum length: 1

From the initial month for all subsequent months of the current fiscal year (Type 1 = fixed value)For the respective month and not carried forward to the subsequent months (Type 2 = totals value)The number of employees is entered as type 1 (fixed value) and the number of long-distance calls is entered as type 2 (totals value).To correct quantities after entering them as statistical key figures, cancel type 2 values by entering the value with a reversed +/- sign. Then enter the correct value.To change key figures of type 1, enter a new fixed value. This value will then be valid for all subsequent periods until you enter new value.

Parameters:

ststcKeyFigCategory -

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<StatisticalKeyFigure>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<StatisticalKeyFigure>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<StatisticalKeyFigure>