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

Class StatisticalKeyFigure

java.lang.Object

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

com.sap.cloud.sdk.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

Original entity name from the Odata EDM: A_StatisticalKeyFigureType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatisticalKeyFigure.StatisticalKeyFigureBuilder Helper class to allow for fluent creation of StatisticalKeyFigure instances.

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.

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

changedOriginalFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addText(StatisticalKeyFigureText... entity) Adds elements to the list of associated StatisticalKeyFigureText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static StatisticalKeyFigure.StatisticalKeyFigureBuilder	builder()
protected boolean	canEqual(Object other)
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.
static <T,DomainT> StatisticalKeyFigureField<T>	field(String fieldName, TypeConverter<T,DomainT> typeConverter) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
String	getControllingArea() (Key Field) Constraints: Not nullable, Maximum length: 4
protected String	getDefaultServicePath()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection()
protected Map<String,Object>	getKey()
String	getStatisticalKeyFigure() (Key Field) Constraints: Not nullable, Maximum length: 6
String	getStstcKeyFigCategory() Constraints: Not nullable, Maximum length: 1
String	getStstcKeyFigQuantityUnit() Constraints: Not nullable, Maximum length: 3
io.vavr.control.Option<List<StatisticalKeyFigureText>>	getTextIfPresent() Retrieval of associated StatisticalKeyFigureText entities (one to many).
List<StatisticalKeyFigureText>	getTextOrFetch() 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
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setStatisticalKeyFigure(String statisticalKeyFigure) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setStstcKeyFigCategory(String ststcKeyFigCategory) Constraints: Not nullable, Maximum length: 1
void	setStstcKeyFigQuantityUnit(String ststcKeyFigQuantityUnit) Constraints: Not nullable, Maximum length: 3
void	setText(List<StatisticalKeyFigureText> value) Overwrites the list of associated StatisticalKeyFigureText entities for the loaded navigation property to_Text.
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

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

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

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

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields

Methods inherited from class java.lang.Object

clone, finalize, 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,
                            List<StatisticalKeyFigureText> toText)

Method Detail

getType

@Nonnull
public Class<StatisticalKeyFigure> getType()

Specified by:

getType in class VdmObject<StatisticalKeyFigure>

Returns:

The class of this object.

setStatisticalKeyFigure

public void setStatisticalKeyFigure(@Nullable
                                    String statisticalKeyFigure)

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

Original property name from the Odata EDM: StatisticalKeyFigure

Parameters:

statisticalKeyFigure - Statistical Key Figure

setControllingArea

public void setControllingArea(@Nullable
                               String controllingArea)

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

Original property name from the Odata EDM: ControllingArea

Parameters:

controllingArea - Controlling Area

setStstcKeyFigQuantityUnit

public void setStstcKeyFigQuantityUnit(@Nullable
                                       String ststcKeyFigQuantityUnit)

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: StstcKeyFigQuantityUnit

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 - Unit of quantity or time with which the tracing factors of the statistical key figures are posted.

setStstcKeyFigCategory

public void setStstcKeyFigCategory(@Nullable
                                   String ststcKeyFigCategory)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: StstcKeyFigCategory

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 - Field defining whether values are fixed in one of two ways:

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<StatisticalKeyFigure>

getKey

@Nonnull
protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<StatisticalKeyFigure>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<StatisticalKeyFigure>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<StatisticalKeyFigure>

field

@Nonnull
public static <T> StatisticalKeyFigureField<T> field(@Nonnull
                                                              String fieldName,
                                                              @Nonnull
                                                              Class<T> fieldType)

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

Type Parameters:

T - The type of the extension field when performing value comparisons.

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.

field

@Nonnull
public static <T,DomainT> StatisticalKeyFigureField<T> field(@Nonnull
                                                                      String fieldName,
                                                                      @Nonnull
                                                                      TypeConverter<T,DomainT> typeConverter)

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

Type Parameters:

T - The type of the extension field when performing value comparisons.

DomainT - The type of the extension field as returned by the OData service.

Parameters:

typeConverter - A TypeConverter instance whose first generic type matches the Java type of the field

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

Returns:

A representation of an extension field from this entity, holding a reference to the given TypeConverter.

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<StatisticalKeyFigure>

Returns:

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

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.

Overrides:

setServicePathForFetch in class VdmEntity<StatisticalKeyFigure>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.

Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.

Overrides:

attachToService in class VdmEntity<StatisticalKeyFigure>

Parameters:

servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<StatisticalKeyFigure>

toMapOfNavigationProperties

@Nonnull
protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<StatisticalKeyFigure>

fetchText

@Nonnull
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

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

Retrieval of associated StatisticalKeyFigureText entities (one to many). This corresponds to the OData 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.

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.

getTextIfPresent

@Nonnull
public io.vavr.control.Option<List<StatisticalKeyFigureText>> getTextIfPresent()

Retrieval of associated StatisticalKeyFigureText entities (one to many). This corresponds to the OData navigation property to_Text.

If the navigation property for an entity StatisticalKeyFigure has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

Returns:

If the information for navigation property to_Text is already loaded, the result will contain the StatisticalKeyFigureText entities. If not, an Option with result state empty 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. This corresponds to the OData 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:

entity - Array of StatisticalKeyFigureText entities.

builder

public static StatisticalKeyFigure.StatisticalKeyFigureBuilder builder()

getStatisticalKeyFigure

@Nullable
public String getStatisticalKeyFigure()

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

Original property name from the Odata EDM: StatisticalKeyFigure

Returns:

Statistical Key Figure

getControllingArea

@Nullable
public String getControllingArea()

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

Original property name from the Odata EDM: ControllingArea

Returns:

Controlling Area

getStstcKeyFigQuantityUnit

@Nullable
public String getStstcKeyFigQuantityUnit()

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: StstcKeyFigQuantityUnit

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

Original property name from the Odata EDM: StstcKeyFigCategory

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:

toString

public String toString()

Overrides:

toString in class VdmObject<StatisticalKeyFigure>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<StatisticalKeyFigure>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<StatisticalKeyFigure>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<StatisticalKeyFigure>