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

Class WhseOutboundDeliveryOrderHead

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<WhseOutboundDeliveryOrderHead>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.warehouseoutbounddeliveryorder.WhseOutboundDeliveryOrderHead
All Implemented Interfaces:
VdmEntitySet
public class WhseOutboundDeliveryOrderHead extends VdmEntity<WhseOutboundDeliveryOrderHead> implements VdmEntitySet
Warehouse Outbound Delivery Order Head

Original entity name from the Odata EDM: WhseOutboundDeliveryOrderHeadType

  • Field Details

  • Constructor Details

  • Method Details

    • getType

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

    • setEWMOutboundDeliveryOrder

      public void setEWMOutboundDeliveryOrder(@Nullable String eWMOutboundDeliveryOrder)
      (Key Field) Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: EWMOutboundDeliveryOrder

      Parameters:
      eWMOutboundDeliveryOrder - Document Number

    • setEWMWarehouse

      public void setEWMWarehouse(@Nullable String eWMWarehouse)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: EWMWarehouse

      Parameters:
      eWMWarehouse - Warehouse Number/Warehouse Complex

    • setEWMDeliveryDocumentCategory

      public void setEWMDeliveryDocumentCategory(@Nullable String eWMDeliveryDocumentCategory)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: EWMDeliveryDocumentCategory

      Parameters:
      eWMDeliveryDocumentCategory - Document Category

    • setEWMDeliveryDocumentType

      public void setEWMDeliveryDocumentType(@Nullable String eWMDeliveryDocumentType)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: EWMDeliveryDocumentType

      Parameters:
      eWMDeliveryDocumentType - Document Type

    • setShipToParty

      public void setShipToParty(@Nullable String shipToParty)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ShipToParty

      Parameters:
      shipToParty - Business Partner Number

    • setShipToPartyName

      public void setShipToPartyName(@Nullable String shipToPartyName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: ShipToPartyName

      Parameters:
      shipToPartyName - Ship-To Party Name

    • setCarrier

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

      Original property name from the Odata EDM: Carrier

      Parameters:
      carrier - Business Partner Number

    • setCarrierName

      public void setCarrierName(@Nullable String carrierName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: CarrierName

      Parameters:
      carrierName - Carrier Name

    • setPlannedDeliveryUTCDateTime

      public void setPlannedDeliveryUTCDateTime(@Nullable OffsetDateTime plannedDeliveryUTCDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: PlannedDeliveryUTCDateTime

      Parameters:
      plannedDeliveryUTCDateTime - Creation Date/Time

    • setPlannedOutOfYardUTCDateTime

      public void setPlannedOutOfYardUTCDateTime(@Nullable OffsetDateTime plannedOutOfYardUTCDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: PlannedOutOfYardUTCDateTime

      Parameters:
      plannedOutOfYardUTCDateTime - Creation Date/Time

    • setIncotermsPart1

      public void setIncotermsPart1(@Nullable String incotermsPart1)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: IncotermsPart1

      Parameters:
      incotermsPart1 - Incoterms (Part 1)

    • setIncotermsPart2

      public void setIncotermsPart2(@Nullable String incotermsPart2)
      Constraints: Not nullable, Maximum length: 28

      Original property name from the Odata EDM: IncotermsPart2

      Parameters:
      incotermsPart2 - Incoterms (Part 2)

    • setEWMRoute

      public void setEWMRoute(@Nullable String eWMRoute)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: EWMRoute

      Parameters:
      eWMRoute - Route Name (Identification)

    • setSalesOrganization

      public void setSalesOrganization(@Nullable String salesOrganization)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: SalesOrganization

      Parameters:
      salesOrganization - Sales Organization

    • setShippingOffice

      public void setShippingOffice(@Nullable String shippingOffice)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: ShippingOffice

      Parameters:
      shippingOffice - Location Number

    • setEWMMeansOfTransport

      public void setEWMMeansOfTransport(@Nullable String eWMMeansOfTransport)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: EWMMeansOfTransport

      Parameters:
      eWMMeansOfTransport - Means-of-Transport ID

    • setEWMMeansOfTransportType

      public void setEWMMeansOfTransportType(@Nullable String eWMMeansOfTransportType)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: EWMMeansOfTransportType

      Parameters:
      eWMMeansOfTransportType - Means of Transport

    • setEWMDelivLastChangeUTCDateTime

      public void setEWMDelivLastChangeUTCDateTime(@Nullable OffsetDateTime eWMDelivLastChangeUTCDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: EWMDelivLastChangeUTCDateTime

      Parameters:
      eWMDelivLastChangeUTCDateTime - UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

    • setEWMShippingReadinessStatus

      public void setEWMShippingReadinessStatus(@Nullable String eWMShippingReadinessStatus)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: EWMShippingReadinessStatus

      Parameters:
      eWMShippingReadinessStatus - Shipping Readiness Status for Delivery

    • setFreightOrder

      public void setFreightOrder(@Nullable String freightOrder)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: FreightOrder

      Parameters:
      freightOrder - Freight Order Number

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • getShipToPartyDocumentAddressIfPresent

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

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

    • setShipToPartyDocumentAddress

      public void setShipToPartyDocumentAddress(WhseDeliveryDocumentAddress value)
      Overwrites the associated WhseDeliveryDocumentAddress entity for the loaded navigation property _ShipToPartyDocumentAddress.
      Parameters:
      value - New WhseDeliveryDocumentAddress entity.

    • getWhseOutbDeliveryOrderItemIfPresent

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

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

    • setWhseOutbDeliveryOrderItem

      public void setWhseOutbDeliveryOrderItem(@Nonnull List<WhseOutboundDeliveryOrderItem> value)
      Overwrites the list of associated WhseOutboundDeliveryOrderItem entities for the loaded navigation property _WhseOutbDeliveryOrderItem.

      If the navigation property _WhseOutbDeliveryOrderItem of a queried WhseOutboundDeliveryOrderHead 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 WhseOutboundDeliveryOrderItem entities.

    • addWhseOutbDeliveryOrderItem

      public void addWhseOutbDeliveryOrderItem(WhseOutboundDeliveryOrderItem... entity)
      Adds elements to the list of associated WhseOutboundDeliveryOrderItem entities. This corresponds to the OData navigation property _WhseOutbDeliveryOrderItem.

      If the navigation property _WhseOutbDeliveryOrderItem of a queried WhseOutboundDeliveryOrderHead 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 WhseOutboundDeliveryOrderItem entities.

    • printLoadingList

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

    • reverseShippingReadiness

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

    • reverseGoodsIssue

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

    • setShippingReadiness

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

    • postGoodsIssue

      @Nonnull public static BoundAction.SingleToSingle<WhseOutboundDeliveryOrderHead,Void> postGoodsIssue()
      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 WhseOutboundDeliveryOrderHead.WhseOutboundDeliveryOrderHeadBuilder builder()

    • getEWMOutboundDeliveryOrder

      @Nullable public String getEWMOutboundDeliveryOrder()
      (Key Field) Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: EWMOutboundDeliveryOrder

      Returns:
      Document Number

    • getEWMWarehouse

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

      Original property name from the Odata EDM: EWMWarehouse

      Returns:
      Warehouse Number/Warehouse Complex

    • getEWMDeliveryDocumentCategory

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

      Original property name from the Odata EDM: EWMDeliveryDocumentCategory

      Returns:
      Document Category

    • getEWMDeliveryDocumentType

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

      Original property name from the Odata EDM: EWMDeliveryDocumentType

      Returns:
      Document Type

    • getShipToParty

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

      Original property name from the Odata EDM: ShipToParty

      Returns:
      Business Partner Number

    • getShipToPartyName

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

      Original property name from the Odata EDM: ShipToPartyName

      Returns:
      Ship-To Party Name

    • getCarrier

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

      Original property name from the Odata EDM: Carrier

      Returns:
      Business Partner Number

    • getCarrierName

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

      Original property name from the Odata EDM: CarrierName

      Returns:
      Carrier Name

    • getPlannedDeliveryUTCDateTime

      @Nullable public OffsetDateTime getPlannedDeliveryUTCDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: PlannedDeliveryUTCDateTime

      Returns:
      Creation Date/Time

    • getPlannedOutOfYardUTCDateTime

      @Nullable public OffsetDateTime getPlannedOutOfYardUTCDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: PlannedOutOfYardUTCDateTime

      Returns:
      Creation Date/Time

    • getIncotermsPart1

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

      Original property name from the Odata EDM: IncotermsPart1

      Returns:
      Incoterms (Part 1)

    • getIncotermsPart2

      @Nullable public String getIncotermsPart2()
      Constraints: Not nullable, Maximum length: 28

      Original property name from the Odata EDM: IncotermsPart2

      Returns:
      Incoterms (Part 2)

    • getEWMRoute

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

      Original property name from the Odata EDM: EWMRoute

      Returns:
      Route Name (Identification)

    • getSalesOrganization

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

      Original property name from the Odata EDM: SalesOrganization

      Returns:
      Sales Organization

    • getShippingOffice

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

      Original property name from the Odata EDM: ShippingOffice

      Returns:
      Location Number

    • getEWMMeansOfTransport

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

      Original property name from the Odata EDM: EWMMeansOfTransport

      Returns:
      Means-of-Transport ID

    • getEWMMeansOfTransportType

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

      Original property name from the Odata EDM: EWMMeansOfTransportType

      Returns:
      Means of Transport

    • getEWMDelivLastChangeUTCDateTime

      @Nullable public OffsetDateTime getEWMDelivLastChangeUTCDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: EWMDelivLastChangeUTCDateTime

      Returns:
      UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

    • getEWMShippingReadinessStatus

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

      Original property name from the Odata EDM: EWMShippingReadinessStatus

      Returns:
      Shipping Readiness Status for Delivery

    • getFreightOrder

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

      Original property name from the Odata EDM: FreightOrder

      Returns:
      Freight Order Number

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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