Package com.commercetools.api.models.order

Interface OrderSetParcelCustomTypeAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>
public interface OrderSetParcelCustomTypeAction extends OrderUpdateAction
OrderSetParcelCustomTypeAction
Example to create an instance using the builder pattern 

     OrderSetParcelCustomTypeAction orderSetParcelCustomTypeAction = OrderSetParcelCustomTypeAction.builder()
             .build()

  • Field Details

    • SET_PARCEL_CUSTOM_TYPE

      static final String SET_PARCEL_CUSTOM_TYPE
      discriminator value for OrderSetParcelCustomTypeAction
      See Also:

  • Method Details

    • getParcelId

      String getParcelId()

      id of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Returns:
      parcelId

    • getParcelKey

      String getParcelKey()

      key of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Returns:
      parcelKey

    • getType

      @Valid @Valid TypeResourceIdentifier getType()

      Defines the Type that extends the Parcel with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Parcel.

      Returns:
      type

    • getFields

      @Valid @Valid FieldContainer getFields()

      Object containing the Custom Fields fields for the Parcel.

      Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

      Returns:
      fields

    • setParcelId

      void setParcelId(String parcelId)

      id of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Parameters:
      parcelId - value to be set

    • setParcelKey

      void setParcelKey(String parcelKey)

      key of an existing Parcel.

      Either parcelId or parcelKey must be provided.

      Parameters:
      parcelKey - value to be set

    • setType

      void setType(TypeResourceIdentifier type)

      Defines the Type that extends the Parcel with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Parcel.

      Parameters:
      type - value to be set

    • setFields

      void setFields(FieldContainer fields)

      Object containing the Custom Fields fields for the Parcel.

      Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

      Parameters:
      fields - value to be set

    • of

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

    • of

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

    • copyDeep

      OrderSetParcelCustomTypeAction copyDeep()
      Specified by:
      copyDeep in interface OrderUpdateAction

    • deepCopy

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

    • builder

      static OrderSetParcelCustomTypeActionBuilder builder()
      builder factory method for OrderSetParcelCustomTypeAction
      Returns:
      builder

    • builder

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

    • withOrderSetParcelCustomTypeAction

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