Package 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>
Statistical Key Figure

Original entity name from the Odata EDM: A_StatisticalKeyFigureType

  • Field Details

    • 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 Details

    • StatisticalKeyFigure

      public StatisticalKeyFigure()

    • StatisticalKeyFigure

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

  • Method Details

    • getType

      @Nonnull public Class<StatisticalKeyFigure> getType()
      Specified by:
      getType in class VdmObject<StatisticalKeyFigure>

    • 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

      Parameters:
      ststcKeyFigQuantityUnit - Unit for statistical key figure

    • setStstcKeyFigCategory

      public void setStstcKeyFigCategory(@Nullable String ststcKeyFigCategory)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: StstcKeyFigCategory

      Parameters:
      ststcKeyFigCategory - Statistical Key Figure Category

    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<StatisticalKeyFigure>

    • getKey

      @Nonnull protected Map<String,Object> getKey()
      Overrides:
      getKey in class VdmObject<StatisticalKeyFigure>

    • 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<T, DomainT> 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()
      Overrides:
      getDestinationForFetch in class VdmEntity<StatisticalKeyFigure>

    • setServicePathForFetch

      protected void setServicePathForFetch(@Nullable String servicePathForFetch)
      Overrides:
      setServicePathForFetch in class VdmEntity<StatisticalKeyFigure>

    • attachToService

      public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
      Overrides:
      attachToService in class VdmEntity<StatisticalKeyFigure>

    • 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()
      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.datamodel.odata.client.exception.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()
      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.datamodel.odata.client.exception.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

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

      Returns:
      Unit for statistical key figure

    • getStstcKeyFigCategory

      @Nullable public String getStstcKeyFigCategory()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: StstcKeyFigCategory

      Returns:
      Statistical Key Figure Category

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class VdmObject<StatisticalKeyFigure>

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class VdmEntity<StatisticalKeyFigure>

    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class VdmEntity<StatisticalKeyFigure>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class VdmEntity<StatisticalKeyFigure>