Package com.commercetools.api.models.store

Interface StoreSetSupplyChannelsAction

All Superinterfaces:
ResourceUpdateAction<StoreUpdateAction>, StoreUpdateAction
public interface StoreSetSupplyChannelsAction extends StoreUpdateAction

Setting a supply channel produces the StoreSupplyChannelsChanged Message.

Setting a Channel without the InventorySupply ChannelRoleEnum returns a MissingRoleOnChannel error.

Example to create an instance using the builder pattern 

     StoreSetSupplyChannelsAction storeSetSupplyChannelsAction = StoreSetSupplyChannelsAction.builder()
             .build()

  • Field Details

    • SET_SUPPLY_CHANNELS

      static final String SET_SUPPLY_CHANNELS
      discriminator value for StoreSetSupplyChannelsAction
      See Also:

  • Method Details

    • getSupplyChannels

      @Valid @Valid List<ChannelResourceIdentifier> getSupplyChannels()

      Value to set. If not defined, the Store's supplyChannels are unset.

      Returns:
      supplyChannels

    • setSupplyChannels

      void setSupplyChannels(ChannelResourceIdentifier... supplyChannels)

      Value to set. If not defined, the Store's supplyChannels are unset.

      Parameters:
      supplyChannels - values to be set

    • setSupplyChannels

      void setSupplyChannels(List<ChannelResourceIdentifier> supplyChannels)

      Value to set. If not defined, the Store's supplyChannels are unset.

      Parameters:
      supplyChannels - values to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static StoreSetSupplyChannelsActionBuilder builder()
      builder factory method for StoreSetSupplyChannelsAction
      Returns:
      builder

    • builder

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

    • withStoreSetSupplyChannelsAction

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