Package com.commercetools.api.models.business_unit

Interface BusinessUnitSetStoreModeAction

All Superinterfaces:
BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>
public interface BusinessUnitSetStoreModeAction extends BusinessUnitUpdateAction

Only Business Units of type Division can be have a store mode of FromParent. Changing the storeMode to FromParent empties the stores array on the BusinessUnit. This update action generates a BusinessUnitStoreModeChanged Message.

Example to create an instance using the builder pattern 

     BusinessUnitSetStoreModeAction businessUnitSetStoreModeAction = BusinessUnitSetStoreModeAction.builder()
             .storeMode(BusinessUnitStoreMode.EXPLICIT)
             .build()

  • Field Details

    • SET_STORE_MODE

      static final String SET_STORE_MODE
      discriminator value for BusinessUnitSetStoreModeAction
      See Also:

  • Method Details

    • getStoreMode

      @NotNull @NotNull BusinessUnitStoreMode getStoreMode()

      Set to Explicit to specify Stores for the Business Unit. Set to FromParent to inherit Stores from a parent.

      Returns:
      storeMode

    • getStores

      @Valid @Valid List<StoreResourceIdentifier> getStores()

      Set the Stores the Business Unit is associated with. Can only be set if storeMode is Explicit.

      Returns:
      stores

    • setStoreMode

      void setStoreMode(BusinessUnitStoreMode storeMode)

      Set to Explicit to specify Stores for the Business Unit. Set to FromParent to inherit Stores from a parent.

      Parameters:
      storeMode - value to be set

    • setStores

      void setStores(StoreResourceIdentifier... stores)

      Set the Stores the Business Unit is associated with. Can only be set if storeMode is Explicit.

      Parameters:
      stores - values to be set

    • setStores

      void setStores(List<StoreResourceIdentifier> stores)

      Set the Stores the Business Unit is associated with. Can only be set if storeMode is Explicit.

      Parameters:
      stores - values to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static BusinessUnitSetStoreModeActionBuilder builder()
      builder factory method for BusinessUnitSetStoreModeAction
      Returns:
      builder

    • builder

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

    • withBusinessUnitSetStoreModeAction

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