Package com.commercetools.api.models.order_edit

Interface StagedOrderSetParcelCustomTypeAction

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

     StagedOrderSetParcelCustomTypeAction stagedOrderSetParcelCustomTypeAction = StagedOrderSetParcelCustomTypeAction.builder()
             .build()

  • Field Details

    • SET_PARCEL_CUSTOM_TYPE

      static final String SET_PARCEL_CUSTOM_TYPE
      discriminator value for StagedOrderSetParcelCustomTypeAction
      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()

      Sets the Custom Fields fields for the Parcel.

      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)

      Sets the Custom Fields fields for the Parcel.

      Parameters:
      fields - value to be set

    • of

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

    • of

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

    • copyDeep

      StagedOrderSetParcelCustomTypeAction copyDeep()
      Specified by:
      copyDeep in interface StagedOrderUpdateAction

    • deepCopy

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

    • builder

      static StagedOrderSetParcelCustomTypeActionBuilder builder()
      builder factory method for StagedOrderSetParcelCustomTypeAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetParcelCustomTypeAction

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