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

Class FreightAgreement

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

Original entity name from the Odata EDM: FreightAgreement_Type

  • Field Details

  • Constructor Details

  • Method Details

    • getType

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

    • setTransportationAgreementUUID

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

      Original property name from the Odata EDM: TransportationAgreementUUID

      Parameters:
      transportationAgreementUUID - Transportation Agreement UUID

    • setTransportationAgreement

      public void setTransportationAgreement(@Nullable String transportationAgreement)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: TransportationAgreement

      Parameters:
      transportationAgreement - Agreement

    • setTransportationAgreementDesc

      public void setTransportationAgreementDesc(@Nullable String transportationAgreementDesc)
      Constraints: Not nullable, Maximum length: 75

      Original property name from the Odata EDM: TransportationAgreementDesc

      Parameters:
      transportationAgreementDesc - Description

    • setTranspAgrmtChangedOnDateTime

      public void setTranspAgrmtChangedOnDateTime(@Nullable OffsetDateTime transpAgrmtChangedOnDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspAgrmtChangedOnDateTime

      Parameters:
      transpAgrmtChangedOnDateTime - Agreement Changed On

    • setTranspAgreementCreatedBy

      public void setTranspAgreementCreatedBy(@Nullable String transpAgreementCreatedBy)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: TranspAgreementCreatedBy

      Parameters:
      transpAgreementCreatedBy - Created By

    • setTranspAgrmtCreatedOnDateTime

      public void setTranspAgrmtCreatedOnDateTime(@Nullable OffsetDateTime transpAgrmtCreatedOnDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspAgrmtCreatedOnDateTime

      Parameters:
      transpAgrmtCreatedOnDateTime - Agreement Created On

    • setTranspAgreementChangedBy

      public void setTranspAgreementChangedBy(@Nullable String transpAgreementChangedBy)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: TranspAgreementChangedBy

      Parameters:
      transpAgreementChangedBy - Changed By

    • setTranspExternalAgreement

      public void setTranspExternalAgreement(@Nullable String transpExternalAgreement)
      Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: TranspExternalAgreement

      Parameters:
      transpExternalAgreement - External Reference Number

    • setTransportationAgreementType

      public void setTransportationAgreementType(@Nullable String transportationAgreementType)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: TransportationAgreementType

      Parameters:
      transportationAgreementType - Agreement Type

    • setTranspAgreementValidFrom

      public void setTranspAgreementValidFrom(@Nullable LocalDate transpAgreementValidFrom)
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspAgreementValidFrom

      Parameters:
      transpAgreementValidFrom - Start Date of Validity

    • setTranspAgreementValidTo

      public void setTranspAgreementValidTo(@Nullable LocalDate transpAgreementValidTo)
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspAgreementValidTo

      Parameters:
      transpAgreementValidTo - End Date of Validity

    • setTranspAgreementTimeZone

      public void setTranspAgreementTimeZone(@Nullable String transpAgreementTimeZone)
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: TranspAgreementTimeZone

      Parameters:
      transpAgreementTimeZone - Time Zone

    • setTranspAgrmtDimnWgtProfile

      public void setTranspAgrmtDimnWgtProfile(@Nullable String transpAgrmtDimnWgtProfile)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: TranspAgrmtDimnWgtProfile

      Parameters:
      transpAgrmtDimnWgtProfile - Dimensional Weight Profile

    • setTransportationAgreementDocCrcy

      public void setTransportationAgreementDocCrcy(@Nullable String transportationAgreementDocCrcy)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: TransportationAgreementDocCrcy

      Parameters:
      transportationAgreementDocCrcy - Document Currency

    • setTransportationShippingType

      public void setTransportationShippingType(@Nullable String transportationShippingType)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: TransportationShippingType

      Parameters:
      transportationShippingType - Shipping Type

    • setTransportationMode

      public void setTransportationMode(@Nullable String transportationMode)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TransportationMode

      Parameters:
      transportationMode - Transportation Mode

    • setTransportationAgreementStatus

      public void setTransportationAgreementStatus(@Nullable String transportationAgreementStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TransportationAgreementStatus

      Parameters:
      transportationAgreementStatus - Transportation Agreement Status

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • getFreightAgreementItemIfPresent

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

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

    • setFreightAgreementItem

      public void setFreightAgreementItem(@Nonnull List<FreightAgreementItem> value)
      Overwrites the list of associated FreightAgreementItem entities for the loaded navigation property _FreightAgreementItem.

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

    • addFreightAgreementItem

      public void addFreightAgreementItem(FreightAgreementItem... entity)
      Adds elements to the list of associated FreightAgreementItem entities. This corresponds to the OData navigation property _FreightAgreementItem.

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

    • getFreightAgreementOrganizationIfPresent

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

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

    • setFreightAgreementOrganization

      public void setFreightAgreementOrganization(@Nonnull List<TFreightAgreementOrganization> value)
      Overwrites the list of associated TFreightAgreementOrganization entities for the loaded navigation property _FreightAgreementOrganization.

      If the navigation property _FreightAgreementOrganization of a queried FreightAgreement 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 TFreightAgreementOrganization entities.

    • addFreightAgreementOrganization

      public void addFreightAgreementOrganization(TFreightAgreementOrganization... entity)
      Adds elements to the list of associated TFreightAgreementOrganization entities. This corresponds to the OData navigation property _FreightAgreementOrganization.

      If the navigation property _FreightAgreementOrganization of a queried FreightAgreement 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 TFreightAgreementOrganization entities.

    • getFreightAgreementPartyIfPresent

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

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

    • setFreightAgreementParty

      public void setFreightAgreementParty(@Nonnull List<FreightAgreementParty> value)
      Overwrites the list of associated FreightAgreementParty entities for the loaded navigation property _FreightAgreementParty.

      If the navigation property _FreightAgreementParty of a queried FreightAgreement 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 FreightAgreementParty entities.

    • addFreightAgreementParty

      public void addFreightAgreementParty(FreightAgreementParty... entity)
      Adds elements to the list of associated FreightAgreementParty entities. This corresponds to the OData navigation property _FreightAgreementParty.

      If the navigation property _FreightAgreementParty of a queried FreightAgreement 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 FreightAgreementParty entities.

    • copyFreightAgreement

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

    • releaseFreightAgreement

      @Nonnull public static BoundAction.SingleToSingle<FreightAgreement,FreightAgreement> releaseFreightAgreement()
      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 FreightAgreement.FreightAgreementBuilder builder()

    • getTransportationAgreementUUID

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

      Original property name from the Odata EDM: TransportationAgreementUUID

      Returns:
      Transportation Agreement UUID

    • getTransportationAgreement

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

      Original property name from the Odata EDM: TransportationAgreement

      Returns:
      Agreement

    • getTransportationAgreementDesc

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

      Original property name from the Odata EDM: TransportationAgreementDesc

      Returns:
      Description

    • getTranspAgrmtChangedOnDateTime

      @Nullable public OffsetDateTime getTranspAgrmtChangedOnDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspAgrmtChangedOnDateTime

      Returns:
      Agreement Changed On

    • getTranspAgreementCreatedBy

      @Nullable public String getTranspAgreementCreatedBy()
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: TranspAgreementCreatedBy

      Returns:
      Created By

    • getTranspAgrmtCreatedOnDateTime

      @Nullable public OffsetDateTime getTranspAgrmtCreatedOnDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspAgrmtCreatedOnDateTime

      Returns:
      Agreement Created On

    • getTranspAgreementChangedBy

      @Nullable public String getTranspAgreementChangedBy()
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: TranspAgreementChangedBy

      Returns:
      Changed By

    • getTranspExternalAgreement

      @Nullable public String getTranspExternalAgreement()
      Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: TranspExternalAgreement

      Returns:
      External Reference Number

    • getTransportationAgreementType

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

      Original property name from the Odata EDM: TransportationAgreementType

      Returns:
      Agreement Type

    • getTranspAgreementValidFrom

      @Nullable public LocalDate getTranspAgreementValidFrom()
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspAgreementValidFrom

      Returns:
      Start Date of Validity

    • getTranspAgreementValidTo

      @Nullable public LocalDate getTranspAgreementValidTo()
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspAgreementValidTo

      Returns:
      End Date of Validity

    • getTranspAgreementTimeZone

      @Nullable public String getTranspAgreementTimeZone()
      Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: TranspAgreementTimeZone

      Returns:
      Time Zone

    • getTranspAgrmtDimnWgtProfile

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

      Original property name from the Odata EDM: TranspAgrmtDimnWgtProfile

      Returns:
      Dimensional Weight Profile

    • getTransportationAgreementDocCrcy

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

      Original property name from the Odata EDM: TransportationAgreementDocCrcy

      Returns:
      Document Currency

    • getTransportationShippingType

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

      Original property name from the Odata EDM: TransportationShippingType

      Returns:
      Shipping Type

    • getTransportationMode

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

      Original property name from the Odata EDM: TransportationMode

      Returns:
      Transportation Mode

    • getTransportationAgreementStatus

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

      Original property name from the Odata EDM: TransportationAgreementStatus

      Returns:
      Transportation Agreement Status

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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