Package com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.productmaster

Class ProductUnitsOfMeasure

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<ProductUnitsOfMeasure>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.productmaster.ProductUnitsOfMeasure
public class ProductUnitsOfMeasure extends VdmEntity<ProductUnitsOfMeasure>
Units of Measure

Original entity name from the Odata EDM: A_ProductUnitsOfMeasureType

  • Field Details

    • ALL_FIELDS

      public static final ProductUnitsOfMeasureSelectable ALL_FIELDS
      Selector for all available fields of ProductUnitsOfMeasure.

    • PRODUCT

      public static final ProductUnitsOfMeasureField<String> PRODUCT
      Use with available fluent helpers to apply the Product field to query operations.

    • ALTERNATIVE_UNIT

      public static final ProductUnitsOfMeasureField<String> ALTERNATIVE_UNIT
      Use with available fluent helpers to apply the AlternativeUnit field to query operations.

    • QUANTITY_NUMERATOR

      public static final ProductUnitsOfMeasureField<BigDecimal> QUANTITY_NUMERATOR
      Use with available fluent helpers to apply the QuantityNumerator field to query operations.

    • QUANTITY_DENOMINATOR

      public static final ProductUnitsOfMeasureField<BigDecimal> QUANTITY_DENOMINATOR
      Use with available fluent helpers to apply the QuantityDenominator field to query operations.

    • MATERIAL_VOLUME

      public static final ProductUnitsOfMeasureField<BigDecimal> MATERIAL_VOLUME
      Use with available fluent helpers to apply the MaterialVolume field to query operations.

    • VOLUME_UNIT

      public static final ProductUnitsOfMeasureField<String> VOLUME_UNIT
      Use with available fluent helpers to apply the VolumeUnit field to query operations.

    • GROSS_WEIGHT

      public static final ProductUnitsOfMeasureField<BigDecimal> GROSS_WEIGHT
      Use with available fluent helpers to apply the GrossWeight field to query operations.

    • WEIGHT_UNIT

      public static final ProductUnitsOfMeasureField<String> WEIGHT_UNIT
      Use with available fluent helpers to apply the WeightUnit field to query operations.

    • GLOBAL_TRADE_ITEM_NUMBER

      public static final ProductUnitsOfMeasureField<String> GLOBAL_TRADE_ITEM_NUMBER
      Use with available fluent helpers to apply the GlobalTradeItemNumber field to query operations.

    • GLOBAL_TRADE_ITEM_NUMBER_CATEGORY

      public static final ProductUnitsOfMeasureField<String> GLOBAL_TRADE_ITEM_NUMBER_CATEGORY
      Use with available fluent helpers to apply the GlobalTradeItemNumberCategory field to query operations.

    • UNIT_SPECIFIC_PRODUCT_LENGTH

      public static final ProductUnitsOfMeasureField<BigDecimal> UNIT_SPECIFIC_PRODUCT_LENGTH
      Use with available fluent helpers to apply the UnitSpecificProductLength field to query operations.

    • UNIT_SPECIFIC_PRODUCT_WIDTH

      public static final ProductUnitsOfMeasureField<BigDecimal> UNIT_SPECIFIC_PRODUCT_WIDTH
      Use with available fluent helpers to apply the UnitSpecificProductWidth field to query operations.

    • UNIT_SPECIFIC_PRODUCT_HEIGHT

      public static final ProductUnitsOfMeasureField<BigDecimal> UNIT_SPECIFIC_PRODUCT_HEIGHT
      Use with available fluent helpers to apply the UnitSpecificProductHeight field to query operations.

    • PRODUCT_MEASUREMENT_UNIT

      public static final ProductUnitsOfMeasureField<String> PRODUCT_MEASUREMENT_UNIT
      Use with available fluent helpers to apply the ProductMeasurementUnit field to query operations.

    • LOWER_LEVEL_PACKAGING_UNIT

      public static final ProductUnitsOfMeasureField<String> LOWER_LEVEL_PACKAGING_UNIT
      Use with available fluent helpers to apply the LowerLevelPackagingUnit field to query operations.

    • REMAINING_VOLUME_AFTER_NESTING

      public static final ProductUnitsOfMeasureField<BigDecimal> REMAINING_VOLUME_AFTER_NESTING
      Use with available fluent helpers to apply the RemainingVolumeAfterNesting field to query operations.

    • MAXIMUM_STACKING_FACTOR

      public static final ProductUnitsOfMeasureField<Short> MAXIMUM_STACKING_FACTOR
      Use with available fluent helpers to apply the MaximumStackingFactor field to query operations.

    • CAPACITY_USAGE

      public static final ProductUnitsOfMeasureField<BigDecimal> CAPACITY_USAGE
      Use with available fluent helpers to apply the CapacityUsage field to query operations.

    • BASE_UNIT

      public static final ProductUnitsOfMeasureField<String> BASE_UNIT
      Use with available fluent helpers to apply the BaseUnit field to query operations.

    • TO_INTERNATIONAL_ARTICLE_NUMBER

      public static final ProductUnitsOfMeasureLink<ProductUnitsOfMeasureEAN> TO_INTERNATIONAL_ARTICLE_NUMBER
      Use with available fluent helpers to apply the to_InternationalArticleNumber navigation property to query operations.

  • Constructor Details

    • ProductUnitsOfMeasure

      public ProductUnitsOfMeasure()

    • ProductUnitsOfMeasure

      public ProductUnitsOfMeasure(@Nullable String product, @Nullable String alternativeUnit, @Nullable BigDecimal quantityNumerator, @Nullable BigDecimal quantityDenominator, @Nullable BigDecimal materialVolume, @Nullable String volumeUnit, @Nullable BigDecimal grossWeight, @Nullable String weightUnit, @Nullable String globalTradeItemNumber, @Nullable String globalTradeItemNumberCategory, @Nullable BigDecimal unitSpecificProductLength, @Nullable BigDecimal unitSpecificProductWidth, @Nullable BigDecimal unitSpecificProductHeight, @Nullable String productMeasurementUnit, @Nullable String lowerLevelPackagingUnit, @Nullable BigDecimal remainingVolumeAfterNesting, @Nullable Short maximumStackingFactor, @Nullable BigDecimal capacityUsage, @Nullable String baseUnit, List<ProductUnitsOfMeasureEAN> toInternationalArticleNumber)

  • Method Details

    • getType

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

    • setProduct

      public void setProduct(@Nullable String product)
      (Key Field) Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: Product

      Parameters:
      product - Product Number

    • setAlternativeUnit

      public void setAlternativeUnit(@Nullable String alternativeUnit)
      (Key Field) Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: AlternativeUnit

      Parameters:
      alternativeUnit - Alternative Unit of Measure for Stockkeeping Unit

    • setQuantityNumerator

      public void setQuantityNumerator(@Nullable BigDecimal quantityNumerator)
      Constraints: Not nullable, Precision: 5, Scale: 0

      Original property name from the Odata EDM: QuantityNumerator

      Parameters:
      quantityNumerator - Numerator for Conversion to Base Units of Measure

    • setQuantityDenominator

      public void setQuantityDenominator(@Nullable BigDecimal quantityDenominator)
      Constraints: Not nullable, Precision: 5, Scale: 0

      Original property name from the Odata EDM: QuantityDenominator

      Parameters:
      quantityDenominator - Denominator for conversion to base units of measure

    • setMaterialVolume

      public void setMaterialVolume(@Nullable BigDecimal materialVolume)
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: MaterialVolume

      Parameters:
      materialVolume - Volume

    • setVolumeUnit

      public void setVolumeUnit(@Nullable String volumeUnit)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: VolumeUnit

      Parameters:
      volumeUnit - Volume Unit

    • setGrossWeight

      public void setGrossWeight(@Nullable BigDecimal grossWeight)
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: GrossWeight

      Parameters:
      grossWeight - Gross Weight

    • setWeightUnit

      public void setWeightUnit(@Nullable String weightUnit)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: WeightUnit

      Parameters:
      weightUnit - Unit of Weight

    • setGlobalTradeItemNumber

      public void setGlobalTradeItemNumber(@Nullable String globalTradeItemNumber)
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: GlobalTradeItemNumber

      Parameters:
      globalTradeItemNumber - International Article Number (EAN/UPC)

    • setGlobalTradeItemNumberCategory

      public void setGlobalTradeItemNumberCategory(@Nullable String globalTradeItemNumberCategory)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: GlobalTradeItemNumberCategory

      Parameters:
      globalTradeItemNumberCategory - Category of Global Trade Item Number (GTIN)

    • setUnitSpecificProductLength

      public void setUnitSpecificProductLength(@Nullable BigDecimal unitSpecificProductLength)
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: UnitSpecificProductLength

      Parameters:
      unitSpecificProductLength - Length

    • setUnitSpecificProductWidth

      public void setUnitSpecificProductWidth(@Nullable BigDecimal unitSpecificProductWidth)
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: UnitSpecificProductWidth

      Parameters:
      unitSpecificProductWidth - Width

    • setUnitSpecificProductHeight

      public void setUnitSpecificProductHeight(@Nullable BigDecimal unitSpecificProductHeight)
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: UnitSpecificProductHeight

      Parameters:
      unitSpecificProductHeight - Height

    • setProductMeasurementUnit

      public void setProductMeasurementUnit(@Nullable String productMeasurementUnit)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: ProductMeasurementUnit

      Parameters:
      productMeasurementUnit - Unit of Dimension for Length/Width/Height

    • setLowerLevelPackagingUnit

      public void setLowerLevelPackagingUnit(@Nullable String lowerLevelPackagingUnit)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: LowerLevelPackagingUnit

      Parameters:
      lowerLevelPackagingUnit - Lower-Level Unit of Measure in a Packing Hierarchy

    • setRemainingVolumeAfterNesting

      public void setRemainingVolumeAfterNesting(@Nullable BigDecimal remainingVolumeAfterNesting)
      Constraints: Not nullable, Precision: 3, Scale: 0

      Original property name from the Odata EDM: RemainingVolumeAfterNesting

      Parameters:
      remainingVolumeAfterNesting - Remaining Volume after Nesting (in Percentage)

    • setMaximumStackingFactor

      public void setMaximumStackingFactor(@Nullable Short maximumStackingFactor)
      Constraints: none

      Original property name from the Odata EDM: MaximumStackingFactor

      Parameters:
      maximumStackingFactor - Maximum Stacking Factor

    • setCapacityUsage

      public void setCapacityUsage(@Nullable BigDecimal capacityUsage)
      Constraints: Not nullable, Precision: 15, Scale: 3

      Original property name from the Odata EDM: CapacityUsage

      Parameters:
      capacityUsage - Capacity Usage

    • setBaseUnit

      public void setBaseUnit(@Nullable String baseUnit)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: BaseUnit

      Parameters:
      baseUnit - Base Unit of Measure

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

      protected void fromMap(Map<String,Object> inputValues)
      Overrides:
      fromMap in class VdmObject<ProductUnitsOfMeasure>

    • field

      @Nonnull public static <T> ProductUnitsOfMeasureField<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> ProductUnitsOfMeasureField<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<ProductUnitsOfMeasure>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

      protected String getDefaultServicePath()
      Overrides:
      getDefaultServicePath in class VdmEntity<ProductUnitsOfMeasure>

    • toMapOfNavigationProperties

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

    • fetchInternationalArticleNumber

      @Nonnull public List<ProductUnitsOfMeasureEAN> fetchInternationalArticleNumber()
      Fetches the ProductUnitsOfMeasureEAN entities (one to many) associated with this entity. This corresponds to the OData navigation property to_InternationalArticleNumber.

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

      Returns:
      List containing one or more associated ProductUnitsOfMeasureEAN 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.

    • getInternationalArticleNumberOrFetch

      @Nonnull public List<ProductUnitsOfMeasureEAN> getInternationalArticleNumberOrFetch()
      Retrieval of associated ProductUnitsOfMeasureEAN entities (one to many). This corresponds to the OData navigation property to_InternationalArticleNumber.

      If the navigation property to_InternationalArticleNumber of a queried ProductUnitsOfMeasure 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 ProductUnitsOfMeasureEAN 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.

    • getInternationalArticleNumberIfPresent

      @Nonnull public io.vavr.control.Option<List<ProductUnitsOfMeasureEAN>> getInternationalArticleNumberIfPresent()
      Retrieval of associated ProductUnitsOfMeasureEAN entities (one to many). This corresponds to the OData navigation property to_InternationalArticleNumber.

      If the navigation property for an entity ProductUnitsOfMeasure 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_InternationalArticleNumber is already loaded, the result will contain the ProductUnitsOfMeasureEAN entities. If not, an Option with result state empty is returned.

    • setInternationalArticleNumber

      public void setInternationalArticleNumber(@Nonnull List<ProductUnitsOfMeasureEAN> value)
      Overwrites the list of associated ProductUnitsOfMeasureEAN entities for the loaded navigation property to_InternationalArticleNumber.

      If the navigation property to_InternationalArticleNumber of a queried ProductUnitsOfMeasure 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 ProductUnitsOfMeasureEAN entities.

    • addInternationalArticleNumber

      public void addInternationalArticleNumber(ProductUnitsOfMeasureEAN... entity)
      Adds elements to the list of associated ProductUnitsOfMeasureEAN entities. This corresponds to the OData navigation property to_InternationalArticleNumber.

      If the navigation property to_InternationalArticleNumber of a queried ProductUnitsOfMeasure 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 ProductUnitsOfMeasureEAN entities.

    • builder

      @Nonnull public static ProductUnitsOfMeasure.ProductUnitsOfMeasureBuilder builder()

    • getProduct

      @Nullable public String getProduct()
      (Key Field) Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: Product

      Returns:
      Product Number

    • getAlternativeUnit

      @Nullable public String getAlternativeUnit()
      (Key Field) Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: AlternativeUnit

      Returns:
      Alternative Unit of Measure for Stockkeeping Unit

    • getQuantityNumerator

      @Nullable public BigDecimal getQuantityNumerator()
      Constraints: Not nullable, Precision: 5, Scale: 0

      Original property name from the Odata EDM: QuantityNumerator

      Returns:
      Numerator for Conversion to Base Units of Measure

    • getQuantityDenominator

      @Nullable public BigDecimal getQuantityDenominator()
      Constraints: Not nullable, Precision: 5, Scale: 0

      Original property name from the Odata EDM: QuantityDenominator

      Returns:
      Denominator for conversion to base units of measure

    • getMaterialVolume

      @Nullable public BigDecimal getMaterialVolume()
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: MaterialVolume

      Returns:
      Volume

    • getVolumeUnit

      @Nullable public String getVolumeUnit()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: VolumeUnit

      Returns:
      Volume Unit

    • getGrossWeight

      @Nullable public BigDecimal getGrossWeight()
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: GrossWeight

      Returns:
      Gross Weight

    • getWeightUnit

      @Nullable public String getWeightUnit()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: WeightUnit

      Returns:
      Unit of Weight

    • getGlobalTradeItemNumber

      @Nullable public String getGlobalTradeItemNumber()
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: GlobalTradeItemNumber

      Returns:
      International Article Number (EAN/UPC)

    • getGlobalTradeItemNumberCategory

      @Nullable public String getGlobalTradeItemNumberCategory()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: GlobalTradeItemNumberCategory

      Returns:
      Category of Global Trade Item Number (GTIN)

    • getUnitSpecificProductLength

      @Nullable public BigDecimal getUnitSpecificProductLength()
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: UnitSpecificProductLength

      Returns:
      Length

    • getUnitSpecificProductWidth

      @Nullable public BigDecimal getUnitSpecificProductWidth()
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: UnitSpecificProductWidth

      Returns:
      Width

    • getUnitSpecificProductHeight

      @Nullable public BigDecimal getUnitSpecificProductHeight()
      Constraints: Not nullable, Precision: 13, Scale: 3

      Original property name from the Odata EDM: UnitSpecificProductHeight

      Returns:
      Height

    • getProductMeasurementUnit

      @Nullable public String getProductMeasurementUnit()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: ProductMeasurementUnit

      Returns:
      Unit of Dimension for Length/Width/Height

    • getLowerLevelPackagingUnit

      @Nullable public String getLowerLevelPackagingUnit()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: LowerLevelPackagingUnit

      Returns:
      Lower-Level Unit of Measure in a Packing Hierarchy

    • getRemainingVolumeAfterNesting

      @Nullable public BigDecimal getRemainingVolumeAfterNesting()
      Constraints: Not nullable, Precision: 3, Scale: 0

      Original property name from the Odata EDM: RemainingVolumeAfterNesting

      Returns:
      Remaining Volume after Nesting (in Percentage)

    • getMaximumStackingFactor

      @Nullable public Short getMaximumStackingFactor()
      Constraints: none

      Original property name from the Odata EDM: MaximumStackingFactor

      Returns:
      Maximum Stacking Factor

    • getCapacityUsage

      @Nullable public BigDecimal getCapacityUsage()
      Constraints: Not nullable, Precision: 15, Scale: 3

      Original property name from the Odata EDM: CapacityUsage

      Returns:
      Capacity Usage

    • getBaseUnit

      @Nullable public String getBaseUnit()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: BaseUnit

      Returns:
      Base Unit of Measure

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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