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

Class WhseOutboundDeliveryOrderHead

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<WhseOutboundDeliveryOrderHead>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseoutbounddeliveryorder.WhseOutboundDeliveryOrderHead
public class WhseOutboundDeliveryOrderHead extends VdmEntity<WhseOutboundDeliveryOrderHead>
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>

    • setOutboundDeliveryOrder

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

      Original property name from the Odata EDM: OutboundDeliveryOrder

      Parameters:
      outboundDeliveryOrder - Document Number

    • setWarehouse

      public void setWarehouse(@Nullable String warehouse)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: Warehouse

      Parameters:
      warehouse - Warehouse Number/Warehouse Complex

    • setDeliveryCategory

      public void setDeliveryCategory(@Nullable String deliveryCategory)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: DeliveryCategory

      Parameters:
      deliveryCategory - Document Category

    • setDeliveryType

      public void setDeliveryType(@Nullable String deliveryType)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: DeliveryType

      Parameters:
      deliveryType - 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 - Name 1 of organization

    • 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 - Name 1 of organization

    • setPlannedDeliveryUTCDateTime

      public void setPlannedDeliveryUTCDateTime(@Nullable ZonedDateTime plannedDeliveryUTCDateTime)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: PlannedDeliveryUTCDateTime

      Parameters:
      plannedDeliveryUTCDateTime - Creation Date/Time

    • setPlannedOutOfYardUTCDateTime

      public void setPlannedOutOfYardUTCDateTime(@Nullable ZonedDateTime plannedOutOfYardUTCDateTime)
      Constraints: Not nullable, Precision: 0

      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)

    • setRoute

      public void setRoute(@Nullable String route)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: Route

      Parameters:
      route - 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

    • setLastChangeDateTime

      public void setLastChangeDateTime(@Nullable ZonedDateTime lastChangeDateTime)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: LastChangeDateTime

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

    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<WhseOutboundDeliveryOrderHead>

    • getKey

      @Nonnull protected Map<String,Object> 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>

    • field

      @Nonnull public static <T> WhseOutboundDeliveryOrderHeadField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
      Use with available fluent helpers to apply an extension field to query operations.
      Type Parameters:
      T - The type of the extension field when performing value comparisons.
      Parameters:
      fieldName - The name of the extension field as returned by the OData service.
      fieldType - The Java type to use for the extension field when performing value comparisons.
      Returns:
      A representation of an extension field from this entity.

    • field

      @Nonnull public static <T, DomainT> WhseOutboundDeliveryOrderHeadField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
      Use with available fluent helpers to apply an extension field to query operations.
      Type Parameters:
      T - The type of the extension field when performing value comparisons.
      DomainT - The type of the extension field as returned by the OData service.
      Parameters:
      typeConverter - A TypeConverter<T, DomainT> instance whose first generic type matches the Java type of the field
      fieldName - The name of the extension field as returned by the OData service.
      Returns:
      A representation of an extension field from this entity, holding a reference to the given TypeConverter.

    • getDestinationForFetch

      @Nullable public HttpDestinationProperties getDestinationForFetch()
      Overrides:
      getDestinationForFetch in class VdmEntity<WhseOutboundDeliveryOrderHead>

    • setServicePathForFetch

      protected void setServicePathForFetch(@Nullable String servicePathForFetch)
      Overrides:
      setServicePathForFetch in class VdmEntity<WhseOutboundDeliveryOrderHead>

    • attachToService

      public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
      Overrides:
      attachToService in class VdmEntity<WhseOutboundDeliveryOrderHead>

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchShipToPartyDocumentAddress

      @Nonnull public List<WhseDeliveryDocumentAddress> fetchShipToPartyDocumentAddress()
      Fetches the WhseDeliveryDocumentAddress entities (one to many) associated with this entity. This corresponds to the OData navigation property to_ShipToPartyDocumentAddress.

      Please note: This method will not cache or persist the query results.

      Returns:
      List containing one or more associated WhseDeliveryDocumentAddress entities. If no entities are associated then an empty list is returned.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getShipToPartyDocumentAddressOrFetch

      @Nonnull public List<WhseDeliveryDocumentAddress> getShipToPartyDocumentAddressOrFetch()
      Retrieval of associated WhseDeliveryDocumentAddress entities (one to many). This corresponds to the OData navigation property to_ShipToPartyDocumentAddress.

      If the navigation property to_ShipToPartyDocumentAddress 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.

      Returns:
      List of associated WhseDeliveryDocumentAddress entities.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getShipToPartyDocumentAddressIfPresent

      @Nonnull public io.vavr.control.Option<List<WhseDeliveryDocumentAddress>> getShipToPartyDocumentAddressIfPresent()
      Retrieval of associated WhseDeliveryDocumentAddress entities (one to many). This corresponds to the OData navigation property to_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 to_ShipToPartyDocumentAddress is already loaded, the result will contain the WhseDeliveryDocumentAddress entities. If not, an Option with result state empty is returned.

    • setShipToPartyDocumentAddress

      public void setShipToPartyDocumentAddress(@Nonnull List<WhseDeliveryDocumentAddress> value)
      Overwrites the list of associated WhseDeliveryDocumentAddress entities for the loaded navigation property to_ShipToPartyDocumentAddress.

      If the navigation property to_ShipToPartyDocumentAddress 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 WhseDeliveryDocumentAddress entities.

    • addShipToPartyDocumentAddress

      public void addShipToPartyDocumentAddress(WhseDeliveryDocumentAddress... entity)
      Adds elements to the list of associated WhseDeliveryDocumentAddress entities. This corresponds to the OData navigation property to_ShipToPartyDocumentAddress.

      If the navigation property to_ShipToPartyDocumentAddress 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 WhseDeliveryDocumentAddress entities.

    • fetchWhseOutboundDeliveryOrderItem

      @Nonnull public List<WhseOutboundDeliveryOrderItem> fetchWhseOutboundDeliveryOrderItem()
      Fetches the WhseOutboundDeliveryOrderItem entities (one to many) associated with this entity. This corresponds to the OData navigation property to_WhseOutboundDeliveryOrderItem.

      Please note: This method will not cache or persist the query results.

      Returns:
      List containing one or more associated WhseOutboundDeliveryOrderItem entities. If no entities are associated then an empty list is returned.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getWhseOutboundDeliveryOrderItemOrFetch

      @Nonnull public List<WhseOutboundDeliveryOrderItem> getWhseOutboundDeliveryOrderItemOrFetch()
      Retrieval of associated WhseOutboundDeliveryOrderItem entities (one to many). This corresponds to the OData navigation property to_WhseOutboundDeliveryOrderItem.

      If the navigation property to_WhseOutboundDeliveryOrderItem 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.

      Returns:
      List of associated WhseOutboundDeliveryOrderItem entities.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getWhseOutboundDeliveryOrderItemIfPresent

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

      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 to_WhseOutboundDeliveryOrderItem is already loaded, the result will contain the WhseOutboundDeliveryOrderItem entities. If not, an Option with result state empty is returned.

    • setWhseOutboundDeliveryOrderItem

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

      If the navigation property to_WhseOutboundDeliveryOrderItem 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.

    • addWhseOutboundDeliveryOrderItem

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

      If the navigation property to_WhseOutboundDeliveryOrderItem 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.

    • builder

      @Nonnull public static WhseOutboundDeliveryOrderHead.WhseOutboundDeliveryOrderHeadBuilder builder()

    • getOutboundDeliveryOrder

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

      Original property name from the Odata EDM: OutboundDeliveryOrder

      Returns:
      Document Number

    • getWarehouse

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

      Original property name from the Odata EDM: Warehouse

      Returns:
      Warehouse Number/Warehouse Complex

    • getDeliveryCategory

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

      Original property name from the Odata EDM: DeliveryCategory

      Returns:
      Document Category

    • getDeliveryType

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

      Original property name from the Odata EDM: DeliveryType

      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:
      Name 1 of organization

    • 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:
      Name 1 of organization

    • getPlannedDeliveryUTCDateTime

      @Nullable public ZonedDateTime getPlannedDeliveryUTCDateTime()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: PlannedDeliveryUTCDateTime

      Returns:
      Creation Date/Time

    • getPlannedOutOfYardUTCDateTime

      @Nullable public ZonedDateTime getPlannedOutOfYardUTCDateTime()
      Constraints: Not nullable, Precision: 0

      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)

    • getRoute

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

      Original property name from the Odata EDM: Route

      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

    • getLastChangeDateTime

      @Nullable public ZonedDateTime getLastChangeDateTime()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: LastChangeDateTime

      Returns:
      UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

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