Package com.commercetools.api.models.channel

Interface ChannelRoleEnum

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
ChannelRoleEnum.ChannelRoleEnumEnum
public interface ChannelRoleEnum extends JsonEnum

Describes the purpose and type of the Channel. A Channel can have one or more roles.

  • Field Details

    • INVENTORY_SUPPLY

      static final ChannelRoleEnum INVENTORY_SUPPLY

      Channel can be used to track inventory entries (for example, Channels with this role can be treated as warehouses).

    • PRODUCT_DISTRIBUTION

      static final ChannelRoleEnum PRODUCT_DISTRIBUTION

      Channel can be used to expose Products to a specific distribution Channel. The Channel can be used by a Cart to select a Product Price.

    • ORDER_EXPORT

      static final ChannelRoleEnum ORDER_EXPORT

      Channel can be used to track order export activities.

    • ORDER_IMPORT

      static final ChannelRoleEnum ORDER_IMPORT

      Channel can be used to track order import activities.

    • PRIMARY

      static final ChannelRoleEnum PRIMARY

      This role can be combined with the other roles (for example, with InventorySupply). If used, the Channel is considered as the primary or main channel among Channels of the same type.

  • Method Details

    • getJsonName

      String getJsonName()
      the JSON value
      Specified by:
      getJsonName in interface JsonEnum
      Returns:
      json value

    • name

      String name()
      the enum value
      Specified by:
      name in interface JsonEnum
      Returns:
      name

    • toString

      String toString()
      convert value to string
      Specified by:
      toString in interface JsonEnum
      Overrides:
      toString in class Object
      Returns:
      string representation

    • findEnum

      static ChannelRoleEnum findEnum(String value)
      factory method for a enum value of ChannelRoleEnum if no enum has been found an anonymous instance will be created
      Parameters:
      value - the enum value to be wrapped
      Returns:
      enum instance

    • findEnumViaJsonName

      static Optional<ChannelRoleEnum> findEnumViaJsonName(String jsonName)
      method to find enum using the JSON value
      Parameters:
      jsonName - the json value to be wrapped
      Returns:
      optional of enum instance

    • values

      static ChannelRoleEnum[] values()
      possible enum values
      Returns:
      array of possible enum values