Package com.commercetools.api.models.category

Interface CategoryReference

All Superinterfaces:
Identifiable<Category>, IdentifiableObjHolder<Category>, Reference, ReferenceMixin
public interface CategoryReference extends Reference, Identifiable<Category>, IdentifiableObjHolder<Category>

Reference to a Category.

Example to create an instance using the builder pattern 

     CategoryReference categoryReference = CategoryReference.builder()
             .id("{id}")
             .build()

  • Field Details

  • Method Details

    • getObj

      @Valid @Valid Category getObj()

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

      Specified by:
      getObj in interface IdentifiableObjHolder<Category>
      Returns:
      obj

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced Category.

      Specified by:
      getId in interface Identifiable<Category>
      Specified by:
      getId in interface Reference
      Specified by:
      getId in interface ReferenceMixin
      Returns:
      id

    • setObj

      void setObj(Category obj)

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

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique identifier of the referenced Category.

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

    • of

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

    • of

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

    • copyDeep

      CategoryReference copyDeep()
      Specified by:
      copyDeep in interface Reference

    • deepCopy

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

    • builder

      static CategoryReferenceBuilder builder()
      builder factory method for CategoryReference
      Returns:
      builder

    • builder

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

    • withCategoryReference

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