Package com.commercetools.api.models.variant_attributes

Interface VariantAttributesAvailability

public interface VariantAttributesAvailability

Lightweight availability information for a Variant. Present only if InventoryEntries exist for the Variant's SKU.

Example to create an instance using the builder pattern 

     VariantAttributesAvailability variantAttributesAvailability = VariantAttributesAvailability.builder()
             .build()

  • Method Details

    • getIsOnStock

      Boolean getIsOnStock()

      Indicates whether the Variant is in stock.

      Returns:
      isOnStock

    • getAvailableQuantity

      Long getAvailableQuantity()

      Number of items of this Variant that are in stock.

      Returns:
      availableQuantity

    • getChannels

      @Valid @Valid VariantAttributesChannelAvailabilityMap getChannels()

      Per-channel availability for the requested supply Channels. Present only when the filter[supplyChannels] query parameter is provided.

      Returns:
      channels

    • setIsOnStock

      void setIsOnStock(Boolean isOnStock)

      Indicates whether the Variant is in stock.

      Parameters:
      isOnStock - value to be set

    • setAvailableQuantity

      void setAvailableQuantity(Long availableQuantity)

      Number of items of this Variant that are in stock.

      Parameters:
      availableQuantity - value to be set

    • setChannels

      void setChannels(VariantAttributesChannelAvailabilityMap channels)

      Per-channel availability for the requested supply Channels. Present only when the filter[supplyChannels] query parameter is provided.

      Parameters:
      channels - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantAttributesAvailability copyDeep()

    • deepCopy

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

    • builder

      static VariantAttributesAvailabilityBuilder builder()
      builder factory method for VariantAttributesAvailability
      Returns:
      builder

    • builder

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

    • withVariantAttributesAvailability

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