Package com.commercetools.api.models.order_edit

Interface OrderEditApplied

All Superinterfaces:
OrderEditResult
public interface OrderEditApplied extends OrderEditResult

Result of a succesful application of stagedActions to the Order.

Example to create an instance using the builder pattern 

     OrderEditApplied orderEditApplied = OrderEditApplied.builder()
             .appliedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .excerptBeforeEdit(excerptBeforeEditBuilder -> excerptBeforeEditBuilder)
             .excerptAfterEdit(excerptAfterEditBuilder -> excerptAfterEditBuilder)
             .build()

  • Field Details

  • Method Details

    • getType

      @NotNull @NotNull String getType()

      This field is queryable.

      Specified by:
      getType in interface OrderEditResult
      Returns:
      type

    • getAppliedAt

      @NotNull @NotNull ZonedDateTime getAppliedAt()

      Date and time (UTC) the Order was edited.

      Returns:
      appliedAt

    • getExcerptBeforeEdit

      @NotNull @Valid @NotNull @Valid OrderExcerpt getExcerptBeforeEdit()

      Prices of the Order before the edit.

      Returns:
      excerptBeforeEdit

    • getExcerptAfterEdit

      @NotNull @Valid @NotNull @Valid OrderExcerpt getExcerptAfterEdit()

      Prices of the Order after the edit.

      Returns:
      excerptAfterEdit

    • setAppliedAt

      void setAppliedAt(ZonedDateTime appliedAt)

      Date and time (UTC) the Order was edited.

      Parameters:
      appliedAt - value to be set

    • setExcerptBeforeEdit

      void setExcerptBeforeEdit(OrderExcerpt excerptBeforeEdit)

      Prices of the Order before the edit.

      Parameters:
      excerptBeforeEdit - value to be set

    • setExcerptAfterEdit

      void setExcerptAfterEdit(OrderExcerpt excerptAfterEdit)

      Prices of the Order after the edit.

      Parameters:
      excerptAfterEdit - value to be set

    • of

      static OrderEditApplied of()
      factory method
      Returns:
      instance of OrderEditApplied

    • of

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

    • deepCopy

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

    • builder

      static OrderEditAppliedBuilder builder()
      builder factory method for OrderEditApplied
      Returns:
      builder

    • builder

      static OrderEditAppliedBuilder builder(OrderEditApplied template)
      create builder for OrderEditApplied instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withOrderEditApplied

      default <T> T withOrderEditApplied(Function<OrderEditApplied,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

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