Package com.commercetools.api.models.store

Interface StoreReference

All Superinterfaces:
Identifiable<Store>, IdentifiableObjHolder<Store>, Reference, ReferenceMixin
public interface StoreReference extends Reference, Identifiable<Store>, IdentifiableObjHolder<Store>

Reference to a Store.

Example to create an instance using the builder pattern 

     StoreReference storeReference = StoreReference.builder()
             .id("{id}")
             .build()

  • Field Details

  • Method Details

    • getObj

      @Valid @Valid Store getObj()

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

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

    • getId

      @NotNull @NotNull String getId()

      Unique ID of the referenced Store.

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

    • setObj

      void setObj(Store obj)

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

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique ID of the referenced Store.

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

    • of

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

    • of

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

    • copyDeep

      StoreReference copyDeep()
      Specified by:
      copyDeep in interface Reference

    • deepCopy

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

    • builder

      static StoreReferenceBuilder builder()
      builder factory method for StoreReference
      Returns:
      builder

    • builder

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

    • withStoreReference

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