Package com.commercetools.api.models.product

Interface ProductRemoveFromCategoryAction

All Superinterfaces:
ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>
public interface ProductRemoveFromCategoryAction extends ProductUpdateAction

Produces the ProductRemovedFromCategory Message.

Example to create an instance using the builder pattern 

     ProductRemoveFromCategoryAction productRemoveFromCategoryAction = ProductRemoveFromCategoryAction.builder()
             .category(categoryBuilder -> categoryBuilder)
             .build()

  • Field Details

    • REMOVE_FROM_CATEGORY

      static final String REMOVE_FROM_CATEGORY
      discriminator value for ProductRemoveFromCategoryAction
      See Also:

  • Method Details

    • getCategory

      @NotNull @Valid @NotNull @Valid CategoryResourceIdentifier getCategory()

      The Category to remove.

      Returns:
      category

    • getStaged

      Boolean getStaged()

      If true, only the staged categories and categoryOrderHints are removed. If false, both the current and staged categories and categoryOrderHints are removed.

      Returns:
      staged

    • setCategory

      void setCategory(CategoryResourceIdentifier category)

      The Category to remove.

      Parameters:
      category - value to be set

    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged categories and categoryOrderHints are removed. If false, both the current and staged categories and categoryOrderHints are removed.

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ProductRemoveFromCategoryActionBuilder builder()
      builder factory method for ProductRemoveFromCategoryAction
      Returns:
      builder

    • builder

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

    • withProductRemoveFromCategoryAction

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