Package com.commercetools.api.models.order_edit

Interface StagedOrderSetParcelCustomFieldAction

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

     StagedOrderSetParcelCustomFieldAction stagedOrderSetParcelCustomFieldAction = StagedOrderSetParcelCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Field Details

    • SET_PARCEL_CUSTOM_FIELD

      static final String SET_PARCEL_CUSTOM_FIELD
      discriminator value for StagedOrderSetParcelCustomFieldAction
      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

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field.

      Returns:
      name

    • getValue

      Object getValue()

      If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Returns:
      value

    • 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

    • setName

      void setName(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set

    • setValue

      void setValue(Object value)

      If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Parameters:
      value - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static StagedOrderSetParcelCustomFieldActionBuilder builder()
      builder factory method for StagedOrderSetParcelCustomFieldAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetParcelCustomFieldAction

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

    • ofUnset

      static StagedOrderSetParcelCustomFieldAction ofUnset(String name, String parcelId)

    • typeReference

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