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

public class FrtAgrmtRateTableValidity extends VdmEntity<FrtAgrmtRateTableValidity> implements VdmEntitySet
Freight Agreement Rate Table Validity

Original entity name from the Odata EDM: FrtAgrmtRateTableValidity_Type

  • Field Details

  • Constructor Details

  • Method Details

    • getType

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

      public void setTranspRateTableValidityUUID(@Nullable UUID transpRateTableValidityUUID)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: TranspRateTableValidityUUID

      Parameters:
      transpRateTableValidityUUID - Transp Rate Table Validity UUID
    • setTransportationRateTableUUID

      public void setTransportationRateTableUUID(@Nullable UUID transportationRateTableUUID)
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationRateTableUUID

      Parameters:
      transportationRateTableUUID - Transportation Rate Table UUID
    • setTransportationAgreementUUID

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

      Original property name from the Odata EDM: TransportationAgreementUUID

      Parameters:
      transportationAgreementUUID - Transportation Agreement UUID
    • setTranspRateTblValidityCurrency

      public void setTranspRateTblValidityCurrency(@Nullable String transpRateTblValidityCurrency)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: TranspRateTblValidityCurrency

      Parameters:
      transpRateTblValidityCurrency - Currency
    • setTranspRateTblValdtyLfcycStatus

      public void setTranspRateTblValdtyLfcycStatus(@Nullable String transpRateTblValdtyLfcycStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TranspRateTblValdtyLfcycStatus

      Parameters:
      transpRateTblValdtyLfcycStatus - Life Cycle Status
    • setTranspRateTblValidityStartDate

      public void setTranspRateTblValidityStartDate(@Nullable LocalDate transpRateTblValidityStartDate)
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspRateTblValidityStartDate

      Parameters:
      transpRateTblValidityStartDate - Start Date of Validity
    • setTranspRateTblValidityEndDate

      public void setTranspRateTblValidityEndDate(@Nullable LocalDate transpRateTblValidityEndDate)
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspRateTblValidityEndDate

      Parameters:
      transpRateTblValidityEndDate - End Date of Validity
    • setTranspRateTblValidityPctUnit

      public void setTranspRateTblValidityPctUnit(@Nullable String transpRateTblValidityPctUnit)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: TranspRateTblValidityPctUnit

      Parameters:
      transpRateTblValidityPctUnit - Unit of Measurement
    • set_Messages

      public void set_Messages(@Nullable Collection<SAP__Message> _Messages)
      Constraints: Not nullable

      Original property name from the Odata EDM: SAP__Messages

      Parameters:
      _Messages - The _Messages to set.
    • getEntityCollection

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

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

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

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

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

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

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

      If the navigation property for an entity FrtAgrmtRateTableValidity 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 _FreightAgreement is already loaded, the result will contain the FreightAgreement entity. If not, an Option with result state empty is returned.
    • setFreightAgreement

      public void setFreightAgreement(FreightAgreement value)
      Overwrites the associated FreightAgreement entity for the loaded navigation property _FreightAgreement.
      Parameters:
      value - New FreightAgreement entity.
    • getFreightAgreementRateTableIfPresent

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

      If the navigation property for an entity FrtAgrmtRateTableValidity 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 _FreightAgreementRateTable is already loaded, the result will contain the FreightAgreementRateTable entity. If not, an Option with result state empty is returned.
    • setFreightAgreementRateTable

      public void setFreightAgreementRateTable(FreightAgreementRateTable value)
      Overwrites the associated FreightAgreementRateTable entity for the loaded navigation property _FreightAgreementRateTable.
      Parameters:
      value - New FreightAgreementRateTable entity.
    • getFrtAgrmtRateTableCalcRuleIfPresent

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

      If the navigation property for an entity FrtAgrmtRateTableValidity 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 _FrtAgrmtRateTableCalcRule is already loaded, the result will contain the FrtAgrmtRateTableCalcRule entities. If not, an Option with result state empty is returned.
    • setFrtAgrmtRateTableCalcRule

      public void setFrtAgrmtRateTableCalcRule(@Nonnull List<FrtAgrmtRateTableCalcRule> value)
      Overwrites the list of associated FrtAgrmtRateTableCalcRule entities for the loaded navigation property _FrtAgrmtRateTableCalcRule.

      If the navigation property _FrtAgrmtRateTableCalcRule of a queried FrtAgrmtRateTableValidity 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 FrtAgrmtRateTableCalcRule entities.
    • addFrtAgrmtRateTableCalcRule

      public void addFrtAgrmtRateTableCalcRule(FrtAgrmtRateTableCalcRule... entity)
      Adds elements to the list of associated FrtAgrmtRateTableCalcRule entities. This corresponds to the OData navigation property _FrtAgrmtRateTableCalcRule.

      If the navigation property _FrtAgrmtRateTableCalcRule of a queried FrtAgrmtRateTableValidity 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 FrtAgrmtRateTableCalcRule entities.
    • getFrtAgrmtRateTableRateIfPresent

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

      If the navigation property for an entity FrtAgrmtRateTableValidity 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 _FrtAgrmtRateTableRate is already loaded, the result will contain the FrtAgrmtRateTableRate entities. If not, an Option with result state empty is returned.
    • setFrtAgrmtRateTableRate

      public void setFrtAgrmtRateTableRate(@Nonnull List<FrtAgrmtRateTableRate> value)
      Overwrites the list of associated FrtAgrmtRateTableRate entities for the loaded navigation property _FrtAgrmtRateTableRate.

      If the navigation property _FrtAgrmtRateTableRate of a queried FrtAgrmtRateTableValidity 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 FrtAgrmtRateTableRate entities.
    • addFrtAgrmtRateTableRate

      public void addFrtAgrmtRateTableRate(FrtAgrmtRateTableRate... entity)
      Adds elements to the list of associated FrtAgrmtRateTableRate entities. This corresponds to the OData navigation property _FrtAgrmtRateTableRate.

      If the navigation property _FrtAgrmtRateTableRate of a queried FrtAgrmtRateTableValidity 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 FrtAgrmtRateTableRate entities.
    • releaseValidityForRateTable

      @Nonnull public static BoundAction.SingleToSingle<FrtAgrmtRateTableValidity,FrtAgrmtRateTableValidity> releaseValidityForRateTable()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.
    • updateTransportationRates

      @Nonnull public static BoundAction.SingleToSingle<FrtAgrmtRateTableValidity,FrtAgrmtRateTableValidity> updateTransportationRates(@Nonnull BigDecimal transpRateIncrDecrInPct, @Nonnull BigDecimal transpRateAmountInRateCrcy, @Nonnull String transpRateValidityCurrency, @Nonnull String transpRateSignIncrDecr)
      Action that can be applied to any entity object of this class.

      Parameters:
      transpRateSignIncrDecr - Constraints: Not nullable, Maximum length: 1

      Original parameter name from the Odata EDM: TranspRateSignIncrDecr

      transpRateIncrDecrInPct - Constraints: Not nullable, Precision: 7, Scale: 2

      Original parameter name from the Odata EDM: TranspRateIncrDecrInPct

      transpRateValidityCurrency - Constraints: Not nullable, Maximum length: 3

      Original parameter name from the Odata EDM: TranspRateValidityCurrency

      transpRateAmountInRateCrcy - Constraints: Not nullable, Precision: 28, Scale: 6

      Original parameter name from the Odata EDM: TranspRateAmountInRateCrcy

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.
    • updateTransportationRates

      @Nonnull public static BoundAction.SingleToSingle<FrtAgrmtRateTableValidity,FrtAgrmtRateTableValidity> updateTransportationRates(@Nonnull BigDecimal transpRateIncrDecrInPct, @Nonnull BigDecimal transpRateAmountInRateCrcy, @Nonnull String transpRateValidityCurrency, @Nonnull String transpRateSignIncrDecr, @Nonnull String transpRateValidityPctUnit)
      Action that can be applied to any entity object of this class.

      Parameters:
      transpRateSignIncrDecr - Constraints: Not nullable, Maximum length: 1

      Original parameter name from the Odata EDM: TranspRateSignIncrDecr

      transpRateIncrDecrInPct - Constraints: Not nullable, Precision: 7, Scale: 2

      Original parameter name from the Odata EDM: TranspRateIncrDecrInPct

      transpRateValidityPctUnit - Constraints: Not nullable, Maximum length: 3

      Original parameter name from the Odata EDM: TranspRateValidityPctUnit

      transpRateValidityCurrency - Constraints: Not nullable, Maximum length: 3

      Original parameter name from the Odata EDM: TranspRateValidityCurrency

      transpRateAmountInRateCrcy - Constraints: Not nullable, Precision: 28, Scale: 6

      Original parameter name from the Odata EDM: TranspRateAmountInRateCrcy

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.
    • copyValidityForRateTable

      @Nonnull public static BoundAction.SingleToSingle<FrtAgrmtRateTableValidity,FrtAgrmtRateTableValidity> copyValidityForRateTable(@Nullable LocalDate transpRateValidityCpyStartDate, @Nullable LocalDate transpRateValidityCpyEndDate)
      Action that can be applied to any entity object of this class.

      Parameters:
      transpRateValidityCpyEndDate - Constraints: Nullable

      Original parameter name from the Odata EDM: TranspRateValidityCpyEndDate

      transpRateValidityCpyStartDate - Constraints: Nullable

      Original parameter name from the Odata EDM: TranspRateValidityCpyStartDate

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.
    • setValdtyStsToInProcForRateTbl

      @Nonnull public static BoundAction.SingleToSingle<FrtAgrmtRateTableValidity,FrtAgrmtRateTableValidity> setValdtyStsToInProcForRateTbl()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.
    • builder

    • getTranspRateTableValidityUUID

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

      Original property name from the Odata EDM: TranspRateTableValidityUUID

      Returns:
      Transp Rate Table Validity UUID
    • getTransportationRateTableUUID

      @Nullable public UUID getTransportationRateTableUUID()
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationRateTableUUID

      Returns:
      Transportation Rate Table UUID
    • getTransportationAgreementUUID

      @Nullable public UUID getTransportationAgreementUUID()
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationAgreementUUID

      Returns:
      Transportation Agreement UUID
    • getTranspRateTblValidityCurrency

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

      Original property name from the Odata EDM: TranspRateTblValidityCurrency

      Returns:
      Currency
    • getTranspRateTblValdtyLfcycStatus

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

      Original property name from the Odata EDM: TranspRateTblValdtyLfcycStatus

      Returns:
      Life Cycle Status
    • getTranspRateTblValidityStartDate

      @Nullable public LocalDate getTranspRateTblValidityStartDate()
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspRateTblValidityStartDate

      Returns:
      Start Date of Validity
    • getTranspRateTblValidityEndDate

      @Nullable public LocalDate getTranspRateTblValidityEndDate()
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspRateTblValidityEndDate

      Returns:
      End Date of Validity
    • getTranspRateTblValidityPctUnit

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

      Original property name from the Odata EDM: TranspRateTblValidityPctUnit

      Returns:
      Unit of Measurement
    • get_Messages

      @Nullable public Collection<SAP__Message> get_Messages()
      Constraints: Not nullable

      Original property name from the Odata EDM: SAP__Messages

      Returns:
      The _Messages contained in this VdmEntity.
    • toString

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

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

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

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

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