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

Class FreightAgreementItem

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<FreightAgreementItem>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.freightagreement.FreightAgreementItem
All Implemented Interfaces:
VdmEntitySet
public class FreightAgreementItem extends VdmEntity<FreightAgreementItem> implements VdmEntitySet
Freight Agreement Item

Original entity name from the Odata EDM: FreightAgreementItem_Type

  • Field Details

  • Constructor Details

  • Method Details

    • getType

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

    • setTranspAgreementItemUUID

      public void setTranspAgreementItemUUID(@Nullable UUID transpAgreementItemUUID)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: TranspAgreementItemUUID

      Parameters:
      transpAgreementItemUUID - Agreement Item UUID

    • setTransportationAgreementUUID

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

      Original property name from the Odata EDM: TransportationAgreementUUID

      Parameters:
      transportationAgreementUUID - Transportation Agreement UUID

    • setTranspCalculationSheetUUID

      public void setTranspCalculationSheetUUID(@Nullable UUID transpCalculationSheetUUID)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspCalculationSheetUUID

      Parameters:
      transpCalculationSheetUUID - Calculation Sheet UUID

    • setTransportationAgreementItem

      public void setTransportationAgreementItem(@Nullable String transportationAgreementItem)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: TransportationAgreementItem

      Parameters:
      transportationAgreementItem - Agreement Item Number

    • setTranspAgreementItemDesc

      public void setTranspAgreementItemDesc(@Nullable String transpAgreementItemDesc)
      Constraints: Not nullable, Maximum length: 75

      Original property name from the Odata EDM: TranspAgreementItemDesc

      Parameters:
      transpAgreementItemDesc - Description

    • setTransportationStageCategory

      public void setTransportationStageCategory(@Nullable String transportationStageCategory)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: TransportationStageCategory

      Parameters:
      transportationStageCategory - Stage Category

    • setTransportationCalculationSheet

      public void setTransportationCalculationSheet(@Nullable String transportationCalculationSheet)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: TransportationCalculationSheet

      Parameters:
      transportationCalculationSheet - Calculation Sheet

    • setTranspCalcSheetItmIsHdrCharge

      public void setTranspCalcSheetItmIsHdrCharge(@Nullable Boolean transpCalcSheetItmIsHdrCharge)
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspCalcSheetItmIsHdrCharge

      Parameters:
      transpCalcSheetItmIsHdrCharge - Boolean Variable (X = True, - = False, Space = Unknown)

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

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

    • getFreightAgrmtCalculationSheetIfPresent

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

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

    • setFreightAgrmtCalculationSheet

      public void setFreightAgrmtCalculationSheet(@Nonnull List<FreightAgrmtCalculationSheet> value)
      Overwrites the list of associated FreightAgrmtCalculationSheet entities for the loaded navigation property _FreightAgrmtCalculationSheet.

      If the navigation property _FreightAgrmtCalculationSheet of a queried FreightAgreementItem 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 FreightAgrmtCalculationSheet entities.

    • addFreightAgrmtCalculationSheet

      public void addFreightAgrmtCalculationSheet(FreightAgrmtCalculationSheet... entity)
      Adds elements to the list of associated FreightAgrmtCalculationSheet entities. This corresponds to the OData navigation property _FreightAgrmtCalculationSheet.

      If the navigation property _FreightAgrmtCalculationSheet of a queried FreightAgreementItem 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 FreightAgrmtCalculationSheet entities.

    • getFrtAgrmtItemPaymentTermIfPresent

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

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

    • setFrtAgrmtItemPaymentTerm

      public void setFrtAgrmtItemPaymentTerm(@Nonnull List<FrtAgrmtItemPaymentTerm> value)
      Overwrites the list of associated FrtAgrmtItemPaymentTerm entities for the loaded navigation property _FrtAgrmtItemPaymentTerm.

      If the navigation property _FrtAgrmtItemPaymentTerm of a queried FreightAgreementItem 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 FrtAgrmtItemPaymentTerm entities.

    • addFrtAgrmtItemPaymentTerm

      public void addFrtAgrmtItemPaymentTerm(FrtAgrmtItemPaymentTerm... entity)
      Adds elements to the list of associated FrtAgrmtItemPaymentTerm entities. This corresponds to the OData navigation property _FrtAgrmtItemPaymentTerm.

      If the navigation property _FrtAgrmtItemPaymentTerm of a queried FreightAgreementItem 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 FrtAgrmtItemPaymentTerm entities.

    • copyFreightAgreementItem

      @Nonnull public static BoundAction.SingleToSingle<FreightAgreementItem,FreightAgreementItem> copyFreightAgreementItem()
      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.

    • addCalculationSheet

      @Nonnull public static BoundAction.SingleToSingle<FreightAgreementItem,FreightAgreementItem> addCalculationSheet()
      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.

    • deleteCalculationSheet

      @Nonnull public static BoundAction.SingleToSingle<FreightAgreementItem,Void> deleteCalculationSheet()
      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

      @Nonnull public static FreightAgreementItem.FreightAgreementItemBuilder builder()

    • getTranspAgreementItemUUID

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

      Original property name from the Odata EDM: TranspAgreementItemUUID

      Returns:
      Agreement Item UUID

    • getTransportationAgreementUUID

      @Nullable public UUID getTransportationAgreementUUID()
      Constraints: Not nullable

      Original property name from the Odata EDM: TransportationAgreementUUID

      Returns:
      Transportation Agreement UUID

    • getTranspCalculationSheetUUID

      @Nullable public UUID getTranspCalculationSheetUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspCalculationSheetUUID

      Returns:
      Calculation Sheet UUID

    • getTransportationAgreementItem

      @Nullable public String getTransportationAgreementItem()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: TransportationAgreementItem

      Returns:
      Agreement Item Number

    • getTranspAgreementItemDesc

      @Nullable public String getTranspAgreementItemDesc()
      Constraints: Not nullable, Maximum length: 75

      Original property name from the Odata EDM: TranspAgreementItemDesc

      Returns:
      Description

    • getTransportationStageCategory

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

      Original property name from the Odata EDM: TransportationStageCategory

      Returns:
      Stage Category

    • getTransportationCalculationSheet

      @Nullable public String getTransportationCalculationSheet()
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: TransportationCalculationSheet

      Returns:
      Calculation Sheet

    • getTranspCalcSheetItmIsHdrCharge

      @Nullable public Boolean getTranspCalcSheetItmIsHdrCharge()
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspCalcSheetItmIsHdrCharge

      Returns:
      Boolean Variable (X = True, - = False, Space = Unknown)

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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