Package com.commercetools.api.models.event

Interface CheckoutMessageOrderPayloadBaseData

public interface CheckoutMessageOrderPayloadBaseData

The data payload of all related order event messages.

Example to create an instance using the builder pattern 

     CheckoutMessageOrderPayloadBaseData checkoutMessageOrderPayloadBaseData = CheckoutMessageOrderPayloadBaseData.builder()
             .projectKey("{projectKey}")
             .cart(cartBuilder -> cartBuilder)
             .plusPayments(paymentsBuilder -> paymentsBuilder)
             .plusErrors(errorsBuilder -> errorsBuilder)
             .build()

  • Method Details

    • getProjectKey

      @NotNull @NotNull String getProjectKey()

      key of the Project where the order would belong to.

      Returns:
      projectKey

    • getCart

      @NotNull @Valid @NotNull @Valid CartReference getCart()

      The Cart on which the change or action was performed.

      Returns:
      cart

    • getPayments

      @NotNull @Valid @NotNull @Valid List<PaymentReference> getPayments()

      The Payments on which the change or action was performed.

      Returns:
      payments

    • getErrors

      @NotNull @Valid @NotNull @Valid List<ErrorObject> getErrors()

      Errors associated with the order event.

      Returns:
      errors

    • setProjectKey

      void setProjectKey(String projectKey)

      key of the Project where the order would belong to.

      Parameters:
      projectKey - value to be set

    • setCart

      void setCart(CartReference cart)

      The Cart on which the change or action was performed.

      Parameters:
      cart - value to be set

    • setPayments

      void setPayments(PaymentReference... payments)

      The Payments on which the change or action was performed.

      Parameters:
      payments - values to be set

    • setPayments

      void setPayments(List<PaymentReference> payments)

      The Payments on which the change or action was performed.

      Parameters:
      payments - values to be set

    • setErrors

      void setErrors(ErrorObject... errors)

      Errors associated with the order event.

      Parameters:
      errors - values to be set

    • setErrors

      void setErrors(List<ErrorObject> errors)

      Errors associated with the order event.

      Parameters:
      errors - values to be set

    • of

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

    • of

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

    • copyDeep

      CheckoutMessageOrderPayloadBaseData copyDeep()

    • deepCopy

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

    • builder

      static CheckoutMessageOrderPayloadBaseDataBuilder builder()
      builder factory method for CheckoutMessageOrderPayloadBaseData
      Returns:
      builder

    • builder

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

    • withCheckoutMessageOrderPayloadBaseData

      default <T> T withCheckoutMessageOrderPayloadBaseData(Function<CheckoutMessageOrderPayloadBaseData,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<CheckoutMessageOrderPayloadBaseData> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference