Package com.commercetools.importapi.models.order_patches

Interface OrderPatchImport

public interface OrderPatchImport

Represents the data used to update an Order in a Project.

Example to create an instance using the builder pattern 

     OrderPatchImport orderPatchImport = OrderPatchImport.builder()
             .orderNumber("{orderNumber}")
             .fields(fieldsBuilder -> fieldsBuilder)
             .build()

  • Method Details

    • getOrderNumber

      @NotNull @NotNull String getOrderNumber()

      User-defined unique identifier. If an Order with this orderNumber exists, it is updated with the imported data.

      Returns:
      orderNumber

    • getFields

      @NotNull @Valid @NotNull @Valid OrderField getFields()

      Each field referenced must be defined in an existing Order or the ImportOperationState is set to validationFailed.

      Returns:
      fields

    • setOrderNumber

      void setOrderNumber(String orderNumber)

      User-defined unique identifier. If an Order with this orderNumber exists, it is updated with the imported data.

      Parameters:
      orderNumber - value to be set

    • setFields

      void setFields(OrderField fields)

      Each field referenced must be defined in an existing Order or the ImportOperationState is set to validationFailed.

      Parameters:
      fields - value to be set

    • of

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

    • of

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

    • copyDeep

      OrderPatchImport copyDeep()

    • deepCopy

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

    • builder

      static OrderPatchImportBuilder builder()
      builder factory method for OrderPatchImport
      Returns:
      builder

    • builder

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

    • withOrderPatchImport

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