Package com.commercetools.api.models.order_edit

Interface StagedOrderSetReturnItemCustomTypeAction

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

     StagedOrderSetReturnItemCustomTypeAction stagedOrderSetReturnItemCustomTypeAction = StagedOrderSetReturnItemCustomTypeAction.builder()
             .build()

  • Field Details

    • SET_RETURN_ITEM_CUSTOM_TYPE

      static final String SET_RETURN_ITEM_CUSTOM_TYPE
      discriminator value for StagedOrderSetReturnItemCustomTypeAction
      See Also:

  • Method Details

    • getReturnItemId

      String getReturnItemId()

      id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Returns:
      returnItemId

    • getReturnItemKey

      String getReturnItemKey()

      key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Returns:
      returnItemKey

    • getType

      @Valid @Valid TypeResourceIdentifier getType()

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

      Returns:
      type

    • getFields

      @Valid @Valid FieldContainer getFields()

      Sets the Custom Fields fields for the Return Item.

      Returns:
      fields

    • setReturnItemId

      void setReturnItemId(String returnItemId)

      id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Parameters:
      returnItemId - value to be set

    • setReturnItemKey

      void setReturnItemKey(String returnItemKey)

      key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

      Parameters:
      returnItemKey - value to be set

    • setType

      void setType(TypeResourceIdentifier type)

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

      Parameters:
      type - value to be set

    • setFields

      void setFields(FieldContainer fields)

      Sets the Custom Fields fields for the Return Item.

      Parameters:
      fields - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static StagedOrderSetReturnItemCustomTypeActionBuilder builder()
      builder factory method for StagedOrderSetReturnItemCustomTypeAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetReturnItemCustomTypeAction

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