Package com.commercetools.api.models.variant

Interface VariantReference

All Superinterfaces:
Reference, ReferenceMixin
public interface VariantReference extends Reference

Reference to a Variant.

Example to create an instance using the builder pattern 

     VariantReference variantReference = VariantReference.builder()
             .id("{id}")
             .build()

  • Field Details

  • Method Details

    • getObj

      @Valid @Valid Variant getObj()

      Contains the representation of the expanded Variant. Only present in responses to requests with Reference Expansion for Variants.

      Returns:
      obj

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced Variant.

      Specified by:
      getId in interface Reference
      Specified by:
      getId in interface ReferenceMixin
      Returns:
      id

    • setObj

      void setObj(Variant obj)

      Contains the representation of the expanded Variant. Only present in responses to requests with Reference Expansion for Variants.

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique identifier of the referenced Variant.

      Specified by:
      setId in interface Reference
      Parameters:
      id - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantReference copyDeep()
      Specified by:
      copyDeep in interface Reference

    • deepCopy

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

    • builder

      static VariantReferenceBuilder builder()
      builder factory method for VariantReference
      Returns:
      builder

    • builder

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

    • withVariantReference

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