public class StatisticalKeyFigure extends VdmEntity<StatisticalKeyFigure>
Original entity name from the Odata EDM: A_StatisticalKeyFigureType
Modifier and Type | Class and Description |
---|---|
static class |
StatisticalKeyFigure.StatisticalKeyFigureBuilder
Helper class to allow for fluent creation of StatisticalKeyFigure instances.
|
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.
|
changedOriginalFields
Constructor and Description |
---|
StatisticalKeyFigure() |
StatisticalKeyFigure(String statisticalKeyFigure,
String controllingArea,
String ststcKeyFigQuantityUnit,
String ststcKeyFigCategory,
List<StatisticalKeyFigureText> toText) |
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> |
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()
Used by fluent helpers and navigation property methods to construct OData queries.
|
HttpDestinationProperties |
getDestinationForFetch()
Convienence field for reusing the same destination with multiple queries (e.g.
|
protected String |
getEntityCollection()
Used by fluent helpers and navigation property methods to construct OData queries.
|
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() |
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
public static final StatisticalKeyFigureSelectable ALL_FIELDS
public static final StatisticalKeyFigureField<String> STATISTICAL_KEY_FIGURE
public static final StatisticalKeyFigureField<String> CONTROLLING_AREA
public static final StatisticalKeyFigureField<String> STSTC_KEY_FIG_QUANTITY_UNIT
public static final StatisticalKeyFigureField<String> STSTC_KEY_FIG_CATEGORY
public static final StatisticalKeyFigureLink<StatisticalKeyFigureText> TO_TEXT
@Nonnull public Class<StatisticalKeyFigure> getType()
getType
in class VdmObject<StatisticalKeyFigure>
public void setStatisticalKeyFigure(@Nullable String statisticalKeyFigure)
Original property name from the Odata EDM: StatisticalKeyFigure
statisticalKeyFigure
- Statistical Key Figurepublic void setControllingArea(@Nullable String controllingArea)
Original property name from the Odata EDM: ControllingArea
controllingArea
- Controlling Areapublic void setStstcKeyFigQuantityUnit(@Nullable String ststcKeyFigQuantityUnit)
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.
ststcKeyFigQuantityUnit
- Unit of quantity or time with which the tracing factors of the statistical key figures are posted.public void setStstcKeyFigCategory(@Nullable String ststcKeyFigCategory)
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.
ststcKeyFigCategory
- Field defining whether values are fixed in one of two ways:protected String getEntityCollection()
VdmEntity
getEntityCollection
in class VdmEntity<StatisticalKeyFigure>
@Nonnull protected Map<String,Object> getKey()
getKey
in class VdmObject<StatisticalKeyFigure>
@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<StatisticalKeyFigure>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<StatisticalKeyFigure>
@Nonnull public static <T> StatisticalKeyFigureField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
T
- The type of the extension field when performing value comparisons.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.@Nonnull public static <T,DomainT> StatisticalKeyFigureField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
T
- The type of the extension field when performing value comparisons.DomainT
- The type of the extension field as returned by the OData service.typeConverter
- A TypeConverterfieldName
- The name of the extension field as returned by the OData service.@Nullable public HttpDestinationProperties getDestinationForFetch()
VdmEntity
getDestinationForFetch
in class VdmEntity<StatisticalKeyFigure>
protected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntity
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.
setServicePathForFetch
in class VdmEntity<StatisticalKeyFigure>
public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
VdmEntity
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.
attachToService
in class VdmEntity<StatisticalKeyFigure>
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.protected String getDefaultServicePath()
VdmEntity
getDefaultServicePath
in class VdmEntity<StatisticalKeyFigure>
protocol://hostname:port
and the OData resource name (entity set, $metadata
, etc.)@Nonnull protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties
in class VdmObject<StatisticalKeyFigure>
@Nonnull public List<StatisticalKeyFigureText> fetchText() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
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.@Nonnull public List<StatisticalKeyFigureText> getTextOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
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.
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.@Nonnull public io.vavr.control.Option<List<StatisticalKeyFigureText>> getTextIfPresent()
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
.
Option
with result state
empty
is returned.public void setText(@Nonnull List<StatisticalKeyFigureText> value)
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.
value
- List of StatisticalKeyFigureText entities.public void addText(StatisticalKeyFigureText... entity)
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.
entity
- Array of StatisticalKeyFigureText entities.public static StatisticalKeyFigure.StatisticalKeyFigureBuilder builder()
@Nullable public String getStatisticalKeyFigure()
Original property name from the Odata EDM: StatisticalKeyFigure
@Nullable public String getControllingArea()
Original property name from the Odata EDM: ControllingArea
@Nullable public String getStstcKeyFigQuantityUnit()
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.
@Nullable public String getStstcKeyFigCategory()
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.
public String toString()
toString
in class VdmObject<StatisticalKeyFigure>
public boolean equals(Object o)
equals
in class VdmObject<StatisticalKeyFigure>
protected boolean canEqual(Object other)
canEqual
in class VdmObject<StatisticalKeyFigure>
public int hashCode()
hashCode
in class VdmObject<StatisticalKeyFigure>
Copyright © 2020 SAP SE. All rights reserved.