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

Class WhseInboundDeliveryHead

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<WhseInboundDeliveryHead>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.warehouseinbounddelivery.WhseInboundDeliveryHead
public class WhseInboundDeliveryHead extends VdmEntity<WhseInboundDeliveryHead>
Warehouse Inbound Delivery Head

Original entity name from the Odata EDM: WhseInboundDeliveryHeadType

  • Field Details

    • ALL_FIELDS

      public static final WhseInboundDeliveryHeadSelectable ALL_FIELDS
      Selector for all available fields of WhseInboundDeliveryHead.

    • INBOUND_DELIVERY

      public static final WhseInboundDeliveryHeadField<String> INBOUND_DELIVERY
      Use with available fluent helpers to apply the InboundDelivery field to query operations.

    • WAREHOUSE

      public static final WhseInboundDeliveryHeadField<String> WAREHOUSE
      Use with available fluent helpers to apply the Warehouse field to query operations.

    • DELIVERY_CATEGORY

      public static final WhseInboundDeliveryHeadField<String> DELIVERY_CATEGORY
      Use with available fluent helpers to apply the DeliveryCategory field to query operations.

    • DELIVERY_TYPE

      public static final WhseInboundDeliveryHeadField<String> DELIVERY_TYPE
      Use with available fluent helpers to apply the DeliveryType field to query operations.

    • SHIP_FROM_PARTY

      public static final WhseInboundDeliveryHeadField<String> SHIP_FROM_PARTY
      Use with available fluent helpers to apply the ShipFromParty field to query operations.

    • SHIP_FROM_PARTY_NAME

      public static final WhseInboundDeliveryHeadField<String> SHIP_FROM_PARTY_NAME
      Use with available fluent helpers to apply the ShipFromPartyName field to query operations.

    • CARRIER

      public static final WhseInboundDeliveryHeadField<String> CARRIER
      Use with available fluent helpers to apply the Carrier field to query operations.

    • CARRIER_NAME

      public static final WhseInboundDeliveryHeadField<String> CARRIER_NAME
      Use with available fluent helpers to apply the CarrierName field to query operations.

    • ADVANCED_SHIPPING_NOTIFICATION

      public static final WhseInboundDeliveryHeadField<String> ADVANCED_SHIPPING_NOTIFICATION
      Use with available fluent helpers to apply the AdvancedShippingNotification field to query operations.

    • PLANNED_DELIVERY_UTC_DATE_TIME

      public static final WhseInboundDeliveryHeadField<ZonedDateTime> PLANNED_DELIVERY_UTC_DATE_TIME
      Use with available fluent helpers to apply the PlannedDeliveryUTCDateTime field to query operations.

    • RECEIVING_OFFICE

      public static final WhseInboundDeliveryHeadField<String> RECEIVING_OFFICE
      Use with available fluent helpers to apply the ReceivingOffice field to query operations.

    • LAST_CHANGE_DATE_TIME

      public static final WhseInboundDeliveryHeadField<ZonedDateTime> LAST_CHANGE_DATE_TIME
      Use with available fluent helpers to apply the LastChangeDateTime field to query operations.

    • TO_WHSE_INBOUND_DELIVERY_ITEM

      public static final WhseInboundDeliveryHeadLink<WhseInboundDeliveryItem> TO_WHSE_INBOUND_DELIVERY_ITEM
      Use with available fluent helpers to apply the to_WhseInboundDeliveryItem navigation property to query operations.

  • Constructor Details

    • WhseInboundDeliveryHead

      public WhseInboundDeliveryHead()

    • WhseInboundDeliveryHead

      public WhseInboundDeliveryHead(@Nullable String inboundDelivery, @Nullable String warehouse, @Nullable String deliveryCategory, @Nullable String deliveryType, @Nullable String shipFromParty, @Nullable String shipFromPartyName, @Nullable String carrier, @Nullable String carrierName, @Nullable String advancedShippingNotification, @Nullable ZonedDateTime plannedDeliveryUTCDateTime, @Nullable String receivingOffice, @Nullable ZonedDateTime lastChangeDateTime, List<WhseInboundDeliveryItem> toWhseInboundDeliveryItem)

  • Method Details

    • getType

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

    • setInboundDelivery

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

      Original property name from the Odata EDM: InboundDelivery

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

    • setShipFromParty

      public void setShipFromParty(@Nullable String shipFromParty)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: ShipFromParty

      Parameters:
      shipFromParty - Business Partner Number

    • setShipFromPartyName

      public void setShipFromPartyName(@Nullable String shipFromPartyName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: ShipFromPartyName

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

    • setAdvancedShippingNotification

      public void setAdvancedShippingNotification(@Nullable String advancedShippingNotification)
      Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: AdvancedShippingNotification

      Parameters:
      advancedShippingNotification - Document Number

    • 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

    • setReceivingOffice

      public void setReceivingOffice(@Nullable String receivingOffice)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: ReceivingOffice

      Parameters:
      receivingOffice - 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<WhseInboundDeliveryHead>

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> WhseInboundDeliveryHeadField<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> WhseInboundDeliveryHeadField<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<WhseInboundDeliveryHead>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchWhseInboundDeliveryItem

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

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

      Returns:
      List containing one or more associated WhseInboundDeliveryItem 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.

    • getWhseInboundDeliveryItemOrFetch

      @Nonnull public List<WhseInboundDeliveryItem> getWhseInboundDeliveryItemOrFetch()
      Retrieval of associated WhseInboundDeliveryItem entities (one to many). This corresponds to the OData navigation property to_WhseInboundDeliveryItem.

      If the navigation property to_WhseInboundDeliveryItem of a queried WhseInboundDeliveryHead 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 WhseInboundDeliveryItem 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.

    • getWhseInboundDeliveryItemIfPresent

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

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

    • setWhseInboundDeliveryItem

      public void setWhseInboundDeliveryItem(@Nonnull List<WhseInboundDeliveryItem> value)
      Overwrites the list of associated WhseInboundDeliveryItem entities for the loaded navigation property to_WhseInboundDeliveryItem.

      If the navigation property to_WhseInboundDeliveryItem of a queried WhseInboundDeliveryHead 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 WhseInboundDeliveryItem entities.

    • addWhseInboundDeliveryItem

      public void addWhseInboundDeliveryItem(WhseInboundDeliveryItem... entity)
      Adds elements to the list of associated WhseInboundDeliveryItem entities. This corresponds to the OData navigation property to_WhseInboundDeliveryItem.

      If the navigation property to_WhseInboundDeliveryItem of a queried WhseInboundDeliveryHead 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 WhseInboundDeliveryItem entities.

    • builder

      @Nonnull public static WhseInboundDeliveryHead.WhseInboundDeliveryHeadBuilder builder()

    • getInboundDelivery

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

      Original property name from the Odata EDM: InboundDelivery

      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

    • getShipFromParty

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

      Original property name from the Odata EDM: ShipFromParty

      Returns:
      Business Partner Number

    • getShipFromPartyName

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

      Original property name from the Odata EDM: ShipFromPartyName

      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

    • getAdvancedShippingNotification

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

      Original property name from the Odata EDM: AdvancedShippingNotification

      Returns:
      Document Number

    • getPlannedDeliveryUTCDateTime

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

      Original property name from the Odata EDM: PlannedDeliveryUTCDateTime

      Returns:
      Creation Date/Time

    • getReceivingOffice

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

      Original property name from the Odata EDM: ReceivingOffice

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

    • equals

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

    • canEqual

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

    • hashCode

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