Interface EstimatedDelivery


public interface EstimatedDelivery

Estimated time window during which a shipment is expected to be delivered. The window is anchored to the selected Shipping Method and the shipping destination.


Example to create an instance using the builder pattern

     EstimatedDelivery estimatedDelivery = EstimatedDelivery.builder()
             .build()
 
  • Method Details

    • getFrom

      ZonedDateTime getFrom()

      Date and time (UTC) of the earliest expected delivery.

      Returns:
      from
    • getUntil

      ZonedDateTime getUntil()

      Date and time (UTC) of the latest expected delivery. When both from and until are set, until must be equal to or later than from.

      Returns:
      until
    • setFrom

      void setFrom(ZonedDateTime from)

      Date and time (UTC) of the earliest expected delivery.

      Parameters:
      from - value to be set
    • setUntil

      void setUntil(ZonedDateTime until)

      Date and time (UTC) of the latest expected delivery. When both from and until are set, until must be equal to or later than from.

      Parameters:
      until - value to be set
    • of

      static EstimatedDelivery of()
      factory method
      Returns:
      instance of EstimatedDelivery
    • of

      static EstimatedDelivery of(EstimatedDelivery template)
      factory method to create a shallow copy EstimatedDelivery
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • copyDeep

      EstimatedDelivery copyDeep()
    • deepCopy

      @Nullable static EstimatedDelivery deepCopy(@Nullable EstimatedDelivery template)
      factory method to create a deep copy of EstimatedDelivery
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • builder

      static EstimatedDeliveryBuilder builder()
      builder factory method for EstimatedDelivery
      Returns:
      builder
    • builder

      static EstimatedDeliveryBuilder builder(EstimatedDelivery template)
      create builder for EstimatedDelivery instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withEstimatedDelivery

      default <T> T withEstimatedDelivery(Function<EstimatedDelivery,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value
    • typeReference

      static tools.jackson.core.type.TypeReference<EstimatedDelivery> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference