Package com.commercetools.api.models.category

Interface CategoryAddStoreAction

All Superinterfaces:
CategoryUpdateAction, ResourceUpdateAction<CategoryUpdateAction>
public interface CategoryAddStoreAction extends CategoryUpdateAction

This action locks the Category and its parent Category. For details, see Category tree locking.

Example to create an instance using the builder pattern 

     CategoryAddStoreAction categoryAddStoreAction = CategoryAddStoreAction.builder()
             .store(storeBuilder -> storeBuilder)
             .build()

  • Field Details

  • Method Details

    • getStore

      @NotNull @Valid @NotNull @Valid StoreResourceIdentifier getStore()

      Value to add to the Category's stores.

      When called through an in-Store endpoint, the caller must have permission for the referenced Store.

      Returns:
      store

    • setStore

      void setStore(StoreResourceIdentifier store)

      Value to add to the Category's stores.

      When called through an in-Store endpoint, the caller must have permission for the referenced Store.

      Parameters:
      store - value to be set

    • of

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

    • of

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

    • copyDeep

      CategoryAddStoreAction copyDeep()
      Specified by:
      copyDeep in interface CategoryUpdateAction

    • deepCopy

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

    • builder

      static CategoryAddStoreActionBuilder builder()
      builder factory method for CategoryAddStoreAction
      Returns:
      builder

    • builder

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

    • withCategoryAddStoreAction

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