Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.freightorderintegration

Class FreightOrderCharge

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<FreightOrderCharge>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.freightorderintegration.FreightOrderCharge
All Implemented Interfaces:
VdmEntitySet
public class FreightOrderCharge extends VdmEntity<FreightOrderCharge> implements VdmEntitySet
Freight Order Charge

Original entity name from the Odata EDM: FreightOrderCharge_Type

  • Field Details

  • Constructor Details

    • FreightOrderCharge

      public FreightOrderCharge()

    • FreightOrderCharge

      public FreightOrderCharge(@Nullable UUID transportationChargesObjUUID, @Nullable UUID transportationOrderUUID, @Nullable String transpChargePostingStatus, @Nullable String transpChargeCalcStatus, @Nullable String transpChargeDocumentCurrency, @Nullable BigDecimal transpChrgTotalAmtInDocCrcy, @Nullable String transpChargeLocalCurrency, @Nullable BigDecimal transpChrgTotalAmtInLoclCrcy, @Nullable OffsetDateTime transpChargeCalculationDateTme, @Nullable LocalDate exchangeRateDate, @Nullable FreightOrder to_FreightOrder, List<FreightOrderChargeItem> to_FreightOrderChargeItem)

  • Method Details

    • getType

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

    • setTransportationChargesObjUUID

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

      Original property name from the Odata EDM: TransportationChargesObjUUID

      Parameters:
      transportationChargesObjUUID - Transportation Charge Object UUID

    • setTransportationOrderUUID

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

      Original property name from the Odata EDM: TransportationOrderUUID

      Parameters:
      transportationOrderUUID - NodeID

    • setTranspChargePostingStatus

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

      Original property name from the Odata EDM: TranspChargePostingStatus

      Parameters:
      transpChargePostingStatus - Posting Status

    • setTranspChargeCalcStatus

      public void setTranspChargeCalcStatus(@Nullable String transpChargeCalcStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TranspChargeCalcStatus

      Parameters:
      transpChargeCalcStatus - Charge Calculation Status

    • setTranspChargeDocumentCurrency

      public void setTranspChargeDocumentCurrency(@Nullable String transpChargeDocumentCurrency)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: TranspChargeDocumentCurrency

      Parameters:
      transpChargeDocumentCurrency - Document Currency

    • setTranspChrgTotalAmtInDocCrcy

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

      Original property name from the Odata EDM: TranspChrgTotalAmtInDocCrcy

      Parameters:
      transpChrgTotalAmtInDocCrcy - Total Amount in Document Currency

    • setTranspChargeLocalCurrency

      public void setTranspChargeLocalCurrency(@Nullable String transpChargeLocalCurrency)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: TranspChargeLocalCurrency

      Parameters:
      transpChargeLocalCurrency - Local Currency

    • setTranspChrgTotalAmtInLoclCrcy

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

      Original property name from the Odata EDM: TranspChrgTotalAmtInLoclCrcy

      Parameters:
      transpChrgTotalAmtInLoclCrcy - Total amount in Local Currency

    • setTranspChargeCalculationDateTme

      public void setTranspChargeCalculationDateTme(@Nullable OffsetDateTime transpChargeCalculationDateTme)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspChargeCalculationDateTme

      Parameters:
      transpChargeCalculationDateTme - 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

    • getEntityCollection

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

    • getKey

      @Nonnull protected ODataEntityKey getKey()
      Overrides:
      getKey in class VdmObject<FreightOrderCharge>

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • 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 FreightOrderCharge 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.

    • getFreightOrderChargeItemIfPresent

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

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

    • setFreightOrderChargeItem

      public void setFreightOrderChargeItem(@Nonnull List<FreightOrderChargeItem> value)
      Overwrites the list of associated FreightOrderChargeItem entities for the loaded navigation property _FreightOrderChargeItem.

      If the navigation property _FreightOrderChargeItem of a queried FreightOrderCharge 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 FreightOrderChargeItem entities.

    • addFreightOrderChargeItem

      public void addFreightOrderChargeItem(FreightOrderChargeItem... entity)
      Adds elements to the list of associated FreightOrderChargeItem entities. This corresponds to the OData navigation property _FreightOrderChargeItem.

      If the navigation property _FreightOrderChargeItem of a queried FreightOrderCharge 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 FreightOrderChargeItem entities.

    • builder

      @Nonnull public static FreightOrderCharge.FreightOrderChargeBuilder builder()

    • getTransportationChargesObjUUID

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

      Original property name from the Odata EDM: TransportationChargesObjUUID

      Returns:
      Transportation Charge Object UUID

    • getTransportationOrderUUID

      @Nullable public UUID getTransportationOrderUUID()
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationOrderUUID

      Returns:
      NodeID

    • getTranspChargePostingStatus

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

      Original property name from the Odata EDM: TranspChargePostingStatus

      Returns:
      Posting Status

    • getTranspChargeCalcStatus

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

      Original property name from the Odata EDM: TranspChargeCalcStatus

      Returns:
      Charge Calculation Status

    • getTranspChargeDocumentCurrency

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

      Original property name from the Odata EDM: TranspChargeDocumentCurrency

      Returns:
      Document Currency

    • getTranspChrgTotalAmtInDocCrcy

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

      Original property name from the Odata EDM: TranspChrgTotalAmtInDocCrcy

      Returns:
      Total Amount in Document Currency

    • getTranspChargeLocalCurrency

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

      Original property name from the Odata EDM: TranspChargeLocalCurrency

      Returns:
      Local Currency

    • getTranspChrgTotalAmtInLoclCrcy

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

      Original property name from the Odata EDM: TranspChrgTotalAmtInLoclCrcy

      Returns:
      Total amount in Local Currency

    • getTranspChargeCalculationDateTme

      @Nullable public OffsetDateTime getTranspChargeCalculationDateTme()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspChargeCalculationDateTme

      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

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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