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

Class FreightOrder

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

Original entity name from the Odata EDM: FreightOrder_Type

  • Field Details

  • Constructor Details

    • FreightOrder

      public FreightOrder()

    • FreightOrder

      public FreightOrder(@Nullable UUID transportationOrderUUID, @Nullable String transportationOrder, @Nullable String transportationOrderType, @Nullable String transportationOrderCategory, @Nullable String transportationShippingType, @Nullable String transportationMode, @Nullable String transportationModeCategory, @Nullable UUID carrierUUID, @Nullable String carrier, @Nullable String standardCarrierAlphaCode, @Nullable UUID transpOrdExecutingCarrierUUID, @Nullable String transpOrdExecutingCarrier, @Nullable UUID shipperUUID, @Nullable String shipper, @Nullable String shipperAddressID, @Nullable UUID consigneeUUID, @Nullable String consignee, @Nullable String consigneeAddressID, @Nullable String transpPurgOrg, @Nullable String transpPurgOrgExtID, @Nullable String transpPurgGroup, @Nullable String transpPurgGroupExtID, @Nullable String purgOrgCompanyCode, @Nullable String carrierAccountNumber, @Nullable String transpMeansOfTransport, @Nullable String transpOrdPartnerReference, @Nullable String transpOrdResponsiblePerson, @Nullable Boolean transpOrdHasMltplExectgPties, @Nullable String transpOrdInvoicingCarrierLevel, @Nullable String transpOrdLifeCycleStatus, @Nullable String transpOrderSubcontrgSts, @Nullable String transportationOrderConfSts, @Nullable String transportationOrderExecSts, @Nullable String transpOrdGoodsMovementStatus, @Nullable String transpOrdWhseProcessingStatus, @Nullable String transpOrderDngrsGdsSts, @Nullable Boolean transpOrdExecutionIsBlocked, @Nullable String transportationOrderCrtnType, @Nullable String createdByUser, @Nullable OffsetDateTime creationDateTime, @Nullable String lastChangedByUser, @Nullable OffsetDateTime changedDateTime, @Nullable Collection<SAP__Message> _Messages, List<FreightOrderBusinessPartner> to_FreightOrderBusinessPartner, @Nullable FreightOrderCharge to_FreightOrderCharge, List<FreightOrderDocRef> to_FreightOrderDocumentReference, List<FreightOrderEvent> to_FreightOrderEvent, List<FreightOrderItem> to_FreightOrderItem, List<FreightOrderStop> to_FreightOrderStop)

  • Method Details

    • getType

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

    • setTransportationOrderUUID

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

      Original property name from the Odata EDM: TransportationOrderUUID

      Parameters:
      transportationOrderUUID - Transportation Order UUID

    • setTransportationOrder

      public void setTransportationOrder(@Nullable String transportationOrder)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: TransportationOrder

      Parameters:
      transportationOrder - Document

    • setTransportationOrderType

      public void setTransportationOrderType(@Nullable String transportationOrderType)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: TransportationOrderType

      Parameters:
      transportationOrderType - Business Document Type

    • setTransportationOrderCategory

      public void setTransportationOrderCategory(@Nullable String transportationOrderCategory)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TransportationOrderCategory

      Parameters:
      transportationOrderCategory - Business Document Category

    • 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

    • setTransportationModeCategory

      public void setTransportationModeCategory(@Nullable String transportationModeCategory)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: TransportationModeCategory

      Parameters:
      transportationModeCategory - Transportation Mode Category

    • setCarrierUUID

      public void setCarrierUUID(@Nullable UUID carrierUUID)
      Constraints: Nullable

      Original property name from the Odata EDM: CarrierUUID

      Parameters:
      carrierUUID - Business Partner GUID

    • setCarrier

      public void setCarrier(@Nullable String carrier)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Carrier

      Parameters:
      carrier - Carrier

    • setStandardCarrierAlphaCode

      public void setStandardCarrierAlphaCode(@Nullable String standardCarrierAlphaCode)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: StandardCarrierAlphaCode

      Parameters:
      standardCarrierAlphaCode - Standard Carrier Alpha Code

    • setTranspOrdExecutingCarrierUUID

      public void setTranspOrdExecutingCarrierUUID(@Nullable UUID transpOrdExecutingCarrierUUID)
      Constraints: Nullable

      Original property name from the Odata EDM: TranspOrdExecutingCarrierUUID

      Parameters:
      transpOrdExecutingCarrierUUID - Executing Carrier UUID

    • setTranspOrdExecutingCarrier

      public void setTranspOrdExecutingCarrier(@Nullable String transpOrdExecutingCarrier)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: TranspOrdExecutingCarrier

      Parameters:
      transpOrdExecutingCarrier - Executing Carrier

    • setShipperUUID

      public void setShipperUUID(@Nullable UUID shipperUUID)
      Constraints: Nullable

      Original property name from the Odata EDM: ShipperUUID

      Parameters:
      shipperUUID - Business Partner GUID

    • setShipper

      public void setShipper(@Nullable String shipper)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Shipper

      Parameters:
      shipper - Shipper

    • setShipperAddressID

      public void setShipperAddressID(@Nullable String shipperAddressID)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: ShipperAddressID

      Parameters:
      shipperAddressID - Unique Identifier for Address (APC_V_ADDRESS_ID)

    • setConsigneeUUID

      public void setConsigneeUUID(@Nullable UUID consigneeUUID)
      Constraints: Nullable

      Original property name from the Odata EDM: ConsigneeUUID

      Parameters:
      consigneeUUID - Business Partner GUID

    • setConsignee

      public void setConsignee(@Nullable String consignee)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Consignee

      Parameters:
      consignee - Ship-to Party

    • setConsigneeAddressID

      public void setConsigneeAddressID(@Nullable String consigneeAddressID)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: ConsigneeAddressID

      Parameters:
      consigneeAddressID - Unique Identifier for Address (APC_V_ADDRESS_ID)

    • setTranspPurgOrg

      public void setTranspPurgOrg(@Nullable String transpPurgOrg)
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: TranspPurgOrg

      Parameters:
      transpPurgOrg - Purchasing Organization

    • setTranspPurgOrgExtID

      public void setTranspPurgOrgExtID(@Nullable String transpPurgOrgExtID)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: TranspPurgOrgExtID

      Parameters:
      transpPurgOrgExtID - Organizational Unit: External ID

    • setTranspPurgGroup

      public void setTranspPurgGroup(@Nullable String transpPurgGroup)
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: TranspPurgGroup

      Parameters:
      transpPurgGroup - Purchasing Group

    • setTranspPurgGroupExtID

      public void setTranspPurgGroupExtID(@Nullable String transpPurgGroupExtID)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: TranspPurgGroupExtID

      Parameters:
      transpPurgGroupExtID - Organizational Unit: External ID

    • setPurgOrgCompanyCode

      public void setPurgOrgCompanyCode(@Nullable String purgOrgCompanyCode)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: PurgOrgCompanyCode

      Parameters:
      purgOrgCompanyCode - Company Code Procuring the Transportation Service

    • setCarrierAccountNumber

      public void setCarrierAccountNumber(@Nullable String carrierAccountNumber)
      Constraints: Not nullable, Maximum length: 14

      Original property name from the Odata EDM: CarrierAccountNumber

      Parameters:
      carrierAccountNumber - Account Number with the Executing Carrier

    • setTranspMeansOfTransport

      public void setTranspMeansOfTransport(@Nullable String transpMeansOfTransport)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: TranspMeansOfTransport

      Parameters:
      transpMeansOfTransport - Means of Transport

    • setTranspOrdPartnerReference

      public void setTranspOrdPartnerReference(@Nullable String transpOrdPartnerReference)
      Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: TranspOrdPartnerReference

      Parameters:
      transpOrdPartnerReference - Partner Reference Number

    • setTranspOrdResponsiblePerson

      public void setTranspOrdResponsiblePerson(@Nullable String transpOrdResponsiblePerson)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: TranspOrdResponsiblePerson

      Parameters:
      transpOrdResponsiblePerson - Person Responsible

    • setTranspOrdHasMltplExectgPties

      public void setTranspOrdHasMltplExectgPties(@Nullable Boolean transpOrdHasMltplExectgPties)
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspOrdHasMltplExectgPties

      Parameters:
      transpOrdHasMltplExectgPties - Multiple Executing Parties

    • setTranspOrdInvoicingCarrierLevel

      public void setTranspOrdInvoicingCarrierLevel(@Nullable String transpOrdInvoicingCarrierLevel)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TranspOrdInvoicingCarrierLevel

      Parameters:
      transpOrdInvoicingCarrierLevel - Invoicing Carrier Level

    • setTranspOrdLifeCycleStatus

      public void setTranspOrdLifeCycleStatus(@Nullable String transpOrdLifeCycleStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TranspOrdLifeCycleStatus

      Parameters:
      transpOrdLifeCycleStatus - Life Cycle Status

    • setTranspOrderSubcontrgSts

      public void setTranspOrderSubcontrgSts(@Nullable String transpOrderSubcontrgSts)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TranspOrderSubcontrgSts

      Parameters:
      transpOrderSubcontrgSts - Subcontracting Status

    • setTransportationOrderConfSts

      public void setTransportationOrderConfSts(@Nullable String transportationOrderConfSts)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TransportationOrderConfSts

      Parameters:
      transportationOrderConfSts - Confirmation Status

    • setTransportationOrderExecSts

      public void setTransportationOrderExecSts(@Nullable String transportationOrderExecSts)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TransportationOrderExecSts

      Parameters:
      transportationOrderExecSts - Execution Status

    • setTranspOrdGoodsMovementStatus

      public void setTranspOrdGoodsMovementStatus(@Nullable String transpOrdGoodsMovementStatus)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: TranspOrdGoodsMovementStatus

      Parameters:
      transpOrdGoodsMovementStatus - Delivery Goods Movement Status

    • setTranspOrdWhseProcessingStatus

      public void setTranspOrdWhseProcessingStatus(@Nullable String transpOrdWhseProcessingStatus)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: TranspOrdWhseProcessingStatus

      Parameters:
      transpOrdWhseProcessingStatus - Warehouse Processing Status

    • setTranspOrderDngrsGdsSts

      public void setTranspOrderDngrsGdsSts(@Nullable String transpOrderDngrsGdsSts)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: TranspOrderDngrsGdsSts

      Parameters:
      transpOrderDngrsGdsSts - Dangerous Goods Status

    • setTranspOrdExecutionIsBlocked

      public void setTranspOrdExecutionIsBlocked(@Nullable Boolean transpOrdExecutionIsBlocked)
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspOrdExecutionIsBlocked

      Parameters:
      transpOrdExecutionIsBlocked - Execution Block

    • setTransportationOrderCrtnType

      public void setTransportationOrderCrtnType(@Nullable String transportationOrderCrtnType)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TransportationOrderCrtnType

      Parameters:
      transportationOrderCrtnType - Creation Type

    • setCreatedByUser

      public void setCreatedByUser(@Nullable String createdByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CreatedByUser

      Parameters:
      createdByUser - Created By

    • setCreationDateTime

      public void setCreationDateTime(@Nullable OffsetDateTime creationDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: CreationDateTime

      Parameters:
      creationDateTime - Created on Timestamp

    • setLastChangedByUser

      public void setLastChangedByUser(@Nullable String lastChangedByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: LastChangedByUser

      Parameters:
      lastChangedByUser - Changed By

    • setChangedDateTime

      public void setChangedDateTime(@Nullable OffsetDateTime changedDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: ChangedDateTime

      Parameters:
      changedDateTime - Created on Timestamp

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • getFreightOrderBusinessPartnerIfPresent

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

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

    • setFreightOrderBusinessPartner

      public void setFreightOrderBusinessPartner(@Nonnull List<FreightOrderBusinessPartner> value)
      Overwrites the list of associated FreightOrderBusinessPartner entities for the loaded navigation property _FreightOrderBusinessPartner.

      If the navigation property _FreightOrderBusinessPartner of a queried FreightOrder 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 FreightOrderBusinessPartner entities.

    • addFreightOrderBusinessPartner

      public void addFreightOrderBusinessPartner(FreightOrderBusinessPartner... entity)
      Adds elements to the list of associated FreightOrderBusinessPartner entities. This corresponds to the OData navigation property _FreightOrderBusinessPartner.

      If the navigation property _FreightOrderBusinessPartner of a queried FreightOrder 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 FreightOrderBusinessPartner entities.

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

    • getFreightOrderDocumentReferenceIfPresent

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

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

    • setFreightOrderDocumentReference

      public void setFreightOrderDocumentReference(@Nonnull List<FreightOrderDocRef> value)
      Overwrites the list of associated FreightOrderDocRef entities for the loaded navigation property _FreightOrderDocumentReference.

      If the navigation property _FreightOrderDocumentReference of a queried FreightOrder 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 FreightOrderDocRef entities.

    • addFreightOrderDocumentReference

      public void addFreightOrderDocumentReference(FreightOrderDocRef... entity)
      Adds elements to the list of associated FreightOrderDocRef entities. This corresponds to the OData navigation property _FreightOrderDocumentReference.

      If the navigation property _FreightOrderDocumentReference of a queried FreightOrder 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 FreightOrderDocRef entities.

    • getFreightOrderEventIfPresent

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

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

    • setFreightOrderEvent

      public void setFreightOrderEvent(@Nonnull List<FreightOrderEvent> value)
      Overwrites the list of associated FreightOrderEvent entities for the loaded navigation property _FreightOrderEvent.

      If the navigation property _FreightOrderEvent of a queried FreightOrder 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 FreightOrderEvent entities.

    • addFreightOrderEvent

      public void addFreightOrderEvent(FreightOrderEvent... entity)
      Adds elements to the list of associated FreightOrderEvent entities. This corresponds to the OData navigation property _FreightOrderEvent.

      If the navigation property _FreightOrderEvent of a queried FreightOrder 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 FreightOrderEvent entities.

    • getFreightOrderItemIfPresent

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

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

    • setFreightOrderItem

      public void setFreightOrderItem(@Nonnull List<FreightOrderItem> value)
      Overwrites the list of associated FreightOrderItem entities for the loaded navigation property _FreightOrderItem.

      If the navigation property _FreightOrderItem of a queried FreightOrder 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 FreightOrderItem entities.

    • addFreightOrderItem

      public void addFreightOrderItem(FreightOrderItem... entity)
      Adds elements to the list of associated FreightOrderItem entities. This corresponds to the OData navigation property _FreightOrderItem.

      If the navigation property _FreightOrderItem of a queried FreightOrder 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 FreightOrderItem entities.

    • getFreightOrderStopIfPresent

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

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

    • setFreightOrderStop

      public void setFreightOrderStop(@Nonnull List<FreightOrderStop> value)
      Overwrites the list of associated FreightOrderStop entities for the loaded navigation property _FreightOrderStop.

      If the navigation property _FreightOrderStop of a queried FreightOrder 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 FreightOrderStop entities.

    • addFreightOrderStop

      public void addFreightOrderStop(FreightOrderStop... entity)
      Adds elements to the list of associated FreightOrderStop entities. This corresponds to the OData navigation property _FreightOrderStop.

      If the navigation property _FreightOrderStop of a queried FreightOrder 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 FreightOrderStop entities.

    • createFreightOrder

      @Nonnull public static BoundAction.CollectionToSingle<FreightOrder,FreightOrder> createFreightOrder(@Nonnull String transportationOrderType, @Nonnull String transportationOrder)
      Action that can be applied to a collection of entities of this class.

      Parameters:
      transportationOrder - Constraints: Not nullable, Maximum length: 20

      Original parameter name from the Odata EDM: TransportationOrder

      transportationOrderType - Constraints: Not nullable, Maximum length: 4

      Original parameter name from the Odata EDM: TransportationOrderType

      Returns:
      Action object prepared with the given parameters to be applied to a collection of entities of this class.

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

    • unassignFreightUnit

      @Nonnull public static BoundAction.SingleToSingle<FreightOrder,Void> unassignFreightUnit(@Nonnull Collection<D_FreightUnitUnassignParameter> _FreightUnits)
      Action that can be applied to any entity object of this class.

      Parameters:
      _FreightUnits - Constraints: Not nullable

      Original parameter name from the Odata EDM: _FreightUnits

      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.

    • calculateTransportationCharges

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

    • cancelFreightOrder

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

    • assignFreightUnit

      @Nonnull public static BoundAction.SingleToSingle<FreightOrder,Void> assignFreightUnit(@Nullable UUID transportationOrderItemUUID, @Nonnull Collection<D_FreightUnitAssignParameter> _FreightUnits)
      Action that can be applied to any entity object of this class.

      Parameters:
      _FreightUnits - Constraints: Not nullable

      Original parameter name from the Odata EDM: _FreightUnits

      transportationOrderItemUUID - Constraints: Nullable

      Original parameter name from the Odata EDM: TransportationOrderItemUUID

      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.

    • reportEvent

      @Nonnull public static BoundAction.SingleToSingle<FreightOrder,Void> reportEvent(@Nonnull String transpOrdEventCode, @Nullable UUID transportationOrderStopUUID, @Nullable OffsetDateTime transpOrdEvtActualDateTime)
      Action that can be applied to any entity object of this class.

      Parameters:
      transpOrdEventCode - Constraints: Not nullable, Maximum length: 20

      Original parameter name from the Odata EDM: TranspOrdEventCode

      transpOrdEvtActualDateTime - Constraints: Nullable

      Original parameter name from the Odata EDM: TranspOrdEvtActualDateTime

      transportationOrderStopUUID - Constraints: Nullable

      Original parameter name from the Odata EDM: TransportationOrderStopUUID

      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 FreightOrder.FreightOrderBuilder builder()

    • getTransportationOrderUUID

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

      Original property name from the Odata EDM: TransportationOrderUUID

      Returns:
      Transportation Order UUID

    • getTransportationOrder

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

      Original property name from the Odata EDM: TransportationOrder

      Returns:
      Document

    • getTransportationOrderType

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

      Original property name from the Odata EDM: TransportationOrderType

      Returns:
      Business Document Type

    • getTransportationOrderCategory

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

      Original property name from the Odata EDM: TransportationOrderCategory

      Returns:
      Business Document Category

    • 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

    • getTransportationModeCategory

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

      Original property name from the Odata EDM: TransportationModeCategory

      Returns:
      Transportation Mode Category

    • getCarrierUUID

      @Nullable public UUID getCarrierUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: CarrierUUID

      Returns:
      Business Partner GUID

    • getCarrier

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

      Original property name from the Odata EDM: Carrier

      Returns:
      Carrier

    • getStandardCarrierAlphaCode

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

      Original property name from the Odata EDM: StandardCarrierAlphaCode

      Returns:
      Standard Carrier Alpha Code

    • getTranspOrdExecutingCarrierUUID

      @Nullable public UUID getTranspOrdExecutingCarrierUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: TranspOrdExecutingCarrierUUID

      Returns:
      Executing Carrier UUID

    • getTranspOrdExecutingCarrier

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

      Original property name from the Odata EDM: TranspOrdExecutingCarrier

      Returns:
      Executing Carrier

    • getShipperUUID

      @Nullable public UUID getShipperUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: ShipperUUID

      Returns:
      Business Partner GUID

    • getShipper

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

      Original property name from the Odata EDM: Shipper

      Returns:
      Shipper

    • getShipperAddressID

      @Nullable public String getShipperAddressID()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: ShipperAddressID

      Returns:
      Unique Identifier for Address (APC_V_ADDRESS_ID)

    • getConsigneeUUID

      @Nullable public UUID getConsigneeUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: ConsigneeUUID

      Returns:
      Business Partner GUID

    • getConsignee

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

      Original property name from the Odata EDM: Consignee

      Returns:
      Ship-to Party

    • getConsigneeAddressID

      @Nullable public String getConsigneeAddressID()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: ConsigneeAddressID

      Returns:
      Unique Identifier for Address (APC_V_ADDRESS_ID)

    • getTranspPurgOrg

      @Nullable public String getTranspPurgOrg()
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: TranspPurgOrg

      Returns:
      Purchasing Organization

    • getTranspPurgOrgExtID

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

      Original property name from the Odata EDM: TranspPurgOrgExtID

      Returns:
      Organizational Unit: External ID

    • getTranspPurgGroup

      @Nullable public String getTranspPurgGroup()
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: TranspPurgGroup

      Returns:
      Purchasing Group

    • getTranspPurgGroupExtID

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

      Original property name from the Odata EDM: TranspPurgGroupExtID

      Returns:
      Organizational Unit: External ID

    • getPurgOrgCompanyCode

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

      Original property name from the Odata EDM: PurgOrgCompanyCode

      Returns:
      Company Code Procuring the Transportation Service

    • getCarrierAccountNumber

      @Nullable public String getCarrierAccountNumber()
      Constraints: Not nullable, Maximum length: 14

      Original property name from the Odata EDM: CarrierAccountNumber

      Returns:
      Account Number with the Executing Carrier

    • getTranspMeansOfTransport

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

      Original property name from the Odata EDM: TranspMeansOfTransport

      Returns:
      Means of Transport

    • getTranspOrdPartnerReference

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

      Original property name from the Odata EDM: TranspOrdPartnerReference

      Returns:
      Partner Reference Number

    • getTranspOrdResponsiblePerson

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

      Original property name from the Odata EDM: TranspOrdResponsiblePerson

      Returns:
      Person Responsible

    • getTranspOrdHasMltplExectgPties

      @Nullable public Boolean getTranspOrdHasMltplExectgPties()
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspOrdHasMltplExectgPties

      Returns:
      Multiple Executing Parties

    • getTranspOrdInvoicingCarrierLevel

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

      Original property name from the Odata EDM: TranspOrdInvoicingCarrierLevel

      Returns:
      Invoicing Carrier Level

    • getTranspOrdLifeCycleStatus

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

      Original property name from the Odata EDM: TranspOrdLifeCycleStatus

      Returns:
      Life Cycle Status

    • getTranspOrderSubcontrgSts

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

      Original property name from the Odata EDM: TranspOrderSubcontrgSts

      Returns:
      Subcontracting Status

    • getTransportationOrderConfSts

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

      Original property name from the Odata EDM: TransportationOrderConfSts

      Returns:
      Confirmation Status

    • getTransportationOrderExecSts

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

      Original property name from the Odata EDM: TransportationOrderExecSts

      Returns:
      Execution Status

    • getTranspOrdGoodsMovementStatus

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

      Original property name from the Odata EDM: TranspOrdGoodsMovementStatus

      Returns:
      Delivery Goods Movement Status

    • getTranspOrdWhseProcessingStatus

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

      Original property name from the Odata EDM: TranspOrdWhseProcessingStatus

      Returns:
      Warehouse Processing Status

    • getTranspOrderDngrsGdsSts

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

      Original property name from the Odata EDM: TranspOrderDngrsGdsSts

      Returns:
      Dangerous Goods Status

    • getTranspOrdExecutionIsBlocked

      @Nullable public Boolean getTranspOrdExecutionIsBlocked()
      Constraints: Not nullable

      Original property name from the Odata EDM: TranspOrdExecutionIsBlocked

      Returns:
      Execution Block

    • getTransportationOrderCrtnType

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

      Original property name from the Odata EDM: TransportationOrderCrtnType

      Returns:
      Creation Type

    • getCreatedByUser

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

      Original property name from the Odata EDM: CreatedByUser

      Returns:
      Created By

    • getCreationDateTime

      @Nullable public OffsetDateTime getCreationDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: CreationDateTime

      Returns:
      Created on Timestamp

    • getLastChangedByUser

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

      Original property name from the Odata EDM: LastChangedByUser

      Returns:
      Changed By

    • getChangedDateTime

      @Nullable public OffsetDateTime getChangedDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: ChangedDateTime

      Returns:
      Created on Timestamp

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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