java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<FreightOrderChargeItem>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.freightorderintegration.FreightOrderChargeItem
All Implemented Interfaces:
VdmEntitySet

public class FreightOrderChargeItem extends VdmEntity<FreightOrderChargeItem> implements VdmEntitySet
Freight Order Charge Item

Original entity name from the Odata EDM: FreightOrderChargeItem_Type

  • Field Details

  • Constructor Details

    • FreightOrderChargeItem

      public FreightOrderChargeItem()
    • FreightOrderChargeItem

      public FreightOrderChargeItem(@Nullable UUID transpChargeItemUUID, @Nullable UUID transportationChargesObjUUID, @Nullable UUID transportationOrderUUID, @Nullable UUID transpChargeCalcLevelRefUUID, @Nullable UUID transportationAgreementUUID, @Nullable UUID businessPartnerUUID, @Nullable String transpChargeCalcLevel, @Nullable String transpChargePostingStatus, @Nullable String transpChrgItemDocCurrency, @Nullable BigDecimal transpChrgItmTotAmtInDocCrcy, @Nullable String transpChrgItemLoclCurrency, @Nullable BigDecimal transpChrgItmTotAmtInLoclCrcy, @Nullable OffsetDateTime transpChargeItemCalcDateTme, @Nullable LocalDate exchangeRateDate, @Nullable LocalDate transpChargePostingDate, @Nullable Boolean transpChrgCalcDteTmeIsChanged, @Nullable String paymentTerms, @Nullable FreightOrder to_FreightOrder, @Nullable FreightOrderCharge to_FreightOrderCharge, List<FrtOrdChrgElement> to_FrtOrdChrgElement, List<FrtOrdChrgItmExchRate> to_FrtOrdChrgItmExchRate)
  • Method Details

    • getType

      @Nonnull public Class<FreightOrderChargeItem> getType()
      Specified by:
      getType in class VdmObject<FreightOrderChargeItem>
    • setTranspChargeItemUUID

      public void setTranspChargeItemUUID(@Nullable UUID transpChargeItemUUID)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: TranspChargeItemUUID

      Parameters:
      transpChargeItemUUID - Transportation Charge Item UUID
    • setTransportationChargesObjUUID

      public void setTransportationChargesObjUUID(@Nullable UUID transportationChargesObjUUID)
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationChargesObjUUID

      Parameters:
      transportationChargesObjUUID - NodeID
    • setTransportationOrderUUID

      public void setTransportationOrderUUID(@Nullable UUID transportationOrderUUID)
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationOrderUUID

      Parameters:
      transportationOrderUUID - NodeID
    • setTranspChargeCalcLevelRefUUID

      public void setTranspChargeCalcLevelRefUUID(@Nullable UUID transpChargeCalcLevelRefUUID)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspChargeCalcLevelRefUUID

      Parameters:
      transpChargeCalcLevelRefUUID - NodeID
    • setTransportationAgreementUUID

      public void setTransportationAgreementUUID(@Nullable UUID transportationAgreementUUID)
      Constraints: Nullable

      Original property name from the Odata EDM: TransportationAgreementUUID

      Parameters:
      transportationAgreementUUID - Internal Universally Unique Identifier
    • setBusinessPartnerUUID

      public void setBusinessPartnerUUID(@Nullable UUID businessPartnerUUID)
      Constraints: Nullable

      Original property name from the Odata EDM: BusinessPartnerUUID

      Parameters:
      businessPartnerUUID - Business Partner GUID
    • setTranspChargeCalcLevel

      public void setTranspChargeCalcLevel(@Nullable String transpChargeCalcLevel)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: TranspChargeCalcLevel

      Parameters:
      transpChargeCalcLevel - Calculation Level
    • setTranspChargePostingStatus

      public void setTranspChargePostingStatus(@Nullable String transpChargePostingStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TranspChargePostingStatus

      Parameters:
      transpChargePostingStatus - Transportation Charge Item Invoicing Status
    • setTranspChrgItemDocCurrency

      public void setTranspChrgItemDocCurrency(@Nullable String transpChrgItemDocCurrency)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: TranspChrgItemDocCurrency

      Parameters:
      transpChrgItemDocCurrency - Currency
    • setTranspChrgItmTotAmtInDocCrcy

      public void setTranspChrgItmTotAmtInDocCrcy(@Nullable BigDecimal transpChrgItmTotAmtInDocCrcy)
      Constraints: Not nullable, Precision: 31, Scale: 0

      Original property name from the Odata EDM: TranspChrgItmTotAmtInDocCrcy

      Parameters:
      transpChrgItmTotAmtInDocCrcy - Total Amount in Document Currency
    • setTranspChrgItemLoclCurrency

      public void setTranspChrgItemLoclCurrency(@Nullable String transpChrgItemLoclCurrency)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: TranspChrgItemLoclCurrency

      Parameters:
      transpChrgItemLoclCurrency - Currency
    • setTranspChrgItmTotAmtInLoclCrcy

      public void setTranspChrgItmTotAmtInLoclCrcy(@Nullable BigDecimal transpChrgItmTotAmtInLoclCrcy)
      Constraints: Not nullable, Precision: 31, Scale: 0

      Original property name from the Odata EDM: TranspChrgItmTotAmtInLoclCrcy

      Parameters:
      transpChrgItmTotAmtInLoclCrcy - Total amount in Local Currency
    • setTranspChargeItemCalcDateTme

      public void setTranspChargeItemCalcDateTme(@Nullable OffsetDateTime transpChargeItemCalcDateTme)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspChargeItemCalcDateTme

      Parameters:
      transpChargeItemCalcDateTme - Calculation Date Timestamp
    • setExchangeRateDate

      public void setExchangeRateDate(@Nullable LocalDate exchangeRateDate)
      Constraints: Nullable

      Original property name from the Odata EDM: ExchangeRateDate

      Parameters:
      exchangeRateDate - Exchange Rate Date for Document Currency Conversion
    • setTranspChargePostingDate

      public void setTranspChargePostingDate(@Nullable LocalDate transpChargePostingDate)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspChargePostingDate

      Parameters:
      transpChargePostingDate - Posting Date
    • setTranspChrgCalcDteTmeIsChanged

      public void setTranspChrgCalcDteTmeIsChanged(@Nullable Boolean transpChrgCalcDteTmeIsChanged)
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspChrgCalcDteTmeIsChanged

      Parameters:
      transpChrgCalcDteTmeIsChanged - Manually-Changed Calculation Date
    • setPaymentTerms

      public void setPaymentTerms(@Nullable String paymentTerms)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: PaymentTerms

      Parameters:
      paymentTerms - Terms of Payment Key
    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<FreightOrderChargeItem>
    • getKey

      @Nonnull protected ODataEntityKey getKey()
      Overrides:
      getKey in class VdmObject<FreightOrderChargeItem>
    • toMapOfFields

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

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

      protected String getDefaultServicePath()
      Overrides:
      getDefaultServicePath in class VdmEntity<FreightOrderChargeItem>
    • toMapOfNavigationProperties

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

      @Nonnull public io.vavr.control.Option<FreightOrder> getFreightOrderIfPresent()
      Retrieval of associated FreightOrder entity (one to one). This corresponds to the OData navigation property _FreightOrder.

      If the navigation property for an entity FreightOrderChargeItem 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 _FreightOrder is already loaded, the result will contain the FreightOrder entity. If not, an Option with result state empty is returned.
    • setFreightOrder

      public void setFreightOrder(FreightOrder value)
      Overwrites the associated FreightOrder entity for the loaded navigation property _FreightOrder.
      Parameters:
      value - New FreightOrder entity.
    • getFreightOrderChargeIfPresent

      @Nonnull public io.vavr.control.Option<FreightOrderCharge> getFreightOrderChargeIfPresent()
      Retrieval of associated FreightOrderCharge entity (one to one). This corresponds to the OData navigation property _FreightOrderCharge.

      If the navigation property for an entity FreightOrderChargeItem 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 _FreightOrderCharge is already loaded, the result will contain the FreightOrderCharge entity. If not, an Option with result state empty is returned.
    • setFreightOrderCharge

      public void setFreightOrderCharge(FreightOrderCharge value)
      Overwrites the associated FreightOrderCharge entity for the loaded navigation property _FreightOrderCharge.
      Parameters:
      value - New FreightOrderCharge entity.
    • getFrtOrdChrgElementIfPresent

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

      If the navigation property for an entity FreightOrderChargeItem 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 _FrtOrdChrgElement is already loaded, the result will contain the FrtOrdChrgElement entities. If not, an Option with result state empty is returned.
    • setFrtOrdChrgElement

      public void setFrtOrdChrgElement(@Nonnull List<FrtOrdChrgElement> value)
      Overwrites the list of associated FrtOrdChrgElement entities for the loaded navigation property _FrtOrdChrgElement.

      If the navigation property _FrtOrdChrgElement of a queried FreightOrderChargeItem 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 FrtOrdChrgElement entities.
    • addFrtOrdChrgElement

      public void addFrtOrdChrgElement(FrtOrdChrgElement... entity)
      Adds elements to the list of associated FrtOrdChrgElement entities. This corresponds to the OData navigation property _FrtOrdChrgElement.

      If the navigation property _FrtOrdChrgElement of a queried FreightOrderChargeItem 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 FrtOrdChrgElement entities.
    • getFrtOrdChrgItmExchRateIfPresent

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

      If the navigation property for an entity FreightOrderChargeItem 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 _FrtOrdChrgItmExchRate is already loaded, the result will contain the FrtOrdChrgItmExchRate entities. If not, an Option with result state empty is returned.
    • setFrtOrdChrgItmExchRate

      public void setFrtOrdChrgItmExchRate(@Nonnull List<FrtOrdChrgItmExchRate> value)
      Overwrites the list of associated FrtOrdChrgItmExchRate entities for the loaded navigation property _FrtOrdChrgItmExchRate.

      If the navigation property _FrtOrdChrgItmExchRate of a queried FreightOrderChargeItem 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 FrtOrdChrgItmExchRate entities.
    • addFrtOrdChrgItmExchRate

      public void addFrtOrdChrgItmExchRate(FrtOrdChrgItmExchRate... entity)
      Adds elements to the list of associated FrtOrdChrgItmExchRate entities. This corresponds to the OData navigation property _FrtOrdChrgItmExchRate.

      If the navigation property _FrtOrdChrgItmExchRate of a queried FreightOrderChargeItem 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 FrtOrdChrgItmExchRate entities.
    • builder

      @Nonnull public static FreightOrderChargeItem.FreightOrderChargeItemBuilder builder()
    • getTranspChargeItemUUID

      @Nullable public UUID getTranspChargeItemUUID()
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: TranspChargeItemUUID

      Returns:
      Transportation Charge Item UUID
    • getTransportationChargesObjUUID

      @Nullable public UUID getTransportationChargesObjUUID()
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationChargesObjUUID

      Returns:
      NodeID
    • getTransportationOrderUUID

      @Nullable public UUID getTransportationOrderUUID()
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationOrderUUID

      Returns:
      NodeID
    • getTranspChargeCalcLevelRefUUID

      @Nullable public UUID getTranspChargeCalcLevelRefUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspChargeCalcLevelRefUUID

      Returns:
      NodeID
    • getTransportationAgreementUUID

      @Nullable public UUID getTransportationAgreementUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: TransportationAgreementUUID

      Returns:
      Internal Universally Unique Identifier
    • getBusinessPartnerUUID

      @Nullable public UUID getBusinessPartnerUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: BusinessPartnerUUID

      Returns:
      Business Partner GUID
    • getTranspChargeCalcLevel

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

      Original property name from the Odata EDM: TranspChargeCalcLevel

      Returns:
      Calculation Level
    • getTranspChargePostingStatus

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

      Original property name from the Odata EDM: TranspChargePostingStatus

      Returns:
      Transportation Charge Item Invoicing Status
    • getTranspChrgItemDocCurrency

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

      Original property name from the Odata EDM: TranspChrgItemDocCurrency

      Returns:
      Currency
    • getTranspChrgItmTotAmtInDocCrcy

      @Nullable public BigDecimal getTranspChrgItmTotAmtInDocCrcy()
      Constraints: Not nullable, Precision: 31, Scale: 0

      Original property name from the Odata EDM: TranspChrgItmTotAmtInDocCrcy

      Returns:
      Total Amount in Document Currency
    • getTranspChrgItemLoclCurrency

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

      Original property name from the Odata EDM: TranspChrgItemLoclCurrency

      Returns:
      Currency
    • getTranspChrgItmTotAmtInLoclCrcy

      @Nullable public BigDecimal getTranspChrgItmTotAmtInLoclCrcy()
      Constraints: Not nullable, Precision: 31, Scale: 0

      Original property name from the Odata EDM: TranspChrgItmTotAmtInLoclCrcy

      Returns:
      Total amount in Local Currency
    • getTranspChargeItemCalcDateTme

      @Nullable public OffsetDateTime getTranspChargeItemCalcDateTme()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspChargeItemCalcDateTme

      Returns:
      Calculation Date Timestamp
    • getExchangeRateDate

      @Nullable public LocalDate getExchangeRateDate()
      Constraints: Nullable

      Original property name from the Odata EDM: ExchangeRateDate

      Returns:
      Exchange Rate Date for Document Currency Conversion
    • getTranspChargePostingDate

      @Nullable public LocalDate getTranspChargePostingDate()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspChargePostingDate

      Returns:
      Posting Date
    • getTranspChrgCalcDteTmeIsChanged

      @Nullable public Boolean getTranspChrgCalcDteTmeIsChanged()
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspChrgCalcDteTmeIsChanged

      Returns:
      Manually-Changed Calculation Date
    • getPaymentTerms

      @Nullable public String getPaymentTerms()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: PaymentTerms

      Returns:
      Terms of Payment Key
    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class VdmObject<FreightOrderChargeItem>
    • equals

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

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

      public int hashCode()
      Overrides:
      hashCode in class VdmEntity<FreightOrderChargeItem>
    • getOdataType

      public String getOdataType()
      Specified by:
      getOdataType in class VdmObject<FreightOrderChargeItem>