Interface ReferenceType

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
ReferenceType.ReferenceTypeEnum

public interface ReferenceType extends JsonEnum

The type of the referenced resource.

  • Field Details

    • CART

      static final ReferenceType CART

      References a cart.

    • CART_DISCOUNT

      static final ReferenceType CART_DISCOUNT

      References a cart discount.

    • CATEGORY

      static final ReferenceType CATEGORY

      References a category.

    • CHANNEL

      static final ReferenceType CHANNEL

      References a channel.

    • CUSTOMER

      static final ReferenceType CUSTOMER

      References a customer.

    • CUSTOMER_GROUP

      static final ReferenceType CUSTOMER_GROUP

      References a customer group.

    • DISCOUNT_CODE

      static final ReferenceType DISCOUNT_CODE

      References a discount code.

    • ORDER

      static final ReferenceType ORDER

      References an order.

    • PAYMENT

      static final ReferenceType PAYMENT

      References a payment

    • PRICE

      static final ReferenceType PRICE

      References a price.

    • PRODUCT

      static final ReferenceType PRODUCT

      References a product.

    • PRODUCT_DISCOUNT

      static final ReferenceType PRODUCT_DISCOUNT

      References a product discount.

    • PRODUCT_TYPE

      static final ReferenceType PRODUCT_TYPE

      References a product type.

    • PRODUCT_VARIANT

      static final ReferenceType PRODUCT_VARIANT

      References a product variant.

    • SHIPPING_METHOD

      static final ReferenceType SHIPPING_METHOD

      References a shipping method.

    • STATE

      static final ReferenceType STATE

      References a state.

    • STORE

      static final ReferenceType STORE

      References a store.

    • TAX_CATEGORY

      static final ReferenceType TAX_CATEGORY

      References a tax-category.

    • TYPE

      static final ReferenceType TYPE

      References a type.

    • KEY_VALUE_DOCUMENT

      static final ReferenceType KEY_VALUE_DOCUMENT

      References a custom object

  • 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 ReferenceType findEnum(String value)
      factory method for a enum value of ReferenceType 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<ReferenceType> 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 ReferenceType[] values()
      possible enum values
      Returns:
      array of possible enum values