Package com.commercetools.api.models.store

Interface Store

All Superinterfaces:
BaseResource, Customizable<Store>, DomainResource<Store>, Identifiable<Store>, Referencable<Store>, ResourceIdentifiable<Store>, StoreMixin, Versioned<Store>, WithKey
public interface Store extends BaseResource, StoreMixin, DomainResource<Store>, Referencable<Store>, ResourceIdentifiable<Store>, Customizable<Store>, WithKey
Store
Example to create an instance using the builder pattern 

     Store store = Store.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .key("{key}")
             .plusLanguages(languagesBuilder -> languagesBuilder)
             .plusCountries(countriesBuilder -> countriesBuilder)
             .plusDistributionChannels(distributionChannelsBuilder -> distributionChannelsBuilder)
             .plusSupplyChannels(supplyChannelsBuilder -> supplyChannelsBuilder)
             .plusProductSelections(productSelectionsBuilder -> productSelectionsBuilder)
             .build()

  • Method Details

    • getId

      @NotNull @NotNull String getId()

      Unique ID of the Store.

      Specified by:
      getId in interface BaseResource
      Specified by:
      getId in interface DomainResource<Store>
      Specified by:
      getId in interface Identifiable<Store>
      Specified by:
      getId in interface Versioned<Store>
      Returns:
      id

    • getVersion

      @NotNull @NotNull Long getVersion()

      Current version of the Store.

      Specified by:
      getVersion in interface BaseResource
      Specified by:
      getVersion in interface DomainResource<Store>
      Specified by:
      getVersion in interface Versioned<Store>
      Returns:
      version

    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

      Date and time (UTC) the Store was initially created.

      Specified by:
      getCreatedAt in interface BaseResource
      Returns:
      createdAt

    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

      Date and time (UTC) the Store was last updated.

      Specified by:
      getLastModifiedAt in interface BaseResource
      Returns:
      lastModifiedAt

    • getLastModifiedBy

      @Valid @Valid LastModifiedBy getLastModifiedBy()

      IDs and references that last modified the Store.

      Returns:
      lastModifiedBy

    • getCreatedBy

      @Valid @Valid CreatedBy getCreatedBy()

      IDs and references that created the Store.

      Returns:
      createdBy

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique and immutable identifier for the Store.

      Specified by:
      getKey in interface WithKey
      Returns:
      key

    • getName

      @Valid @Valid LocalizedString getName()

      Name of the Store.

      Returns:
      name

    • getLanguages

      @NotNull @NotNull List<String> getLanguages()

      Languages configured for the Store.

      Returns:
      languages

    • getCountries

      @NotNull @Valid @NotNull @Valid List<StoreCountry> getCountries()

      Countries defined for the Store.

      Returns:
      countries

    • getDistributionChannels

      @NotNull @Valid @NotNull @Valid List<ChannelReference> getDistributionChannels()

      Product Distribution Channels allowed for the Store.

      Returns:
      distributionChannels

    • getSupplyChannels

      @NotNull @Valid @NotNull @Valid List<ChannelReference> getSupplyChannels()

      Inventory Supply Channels allowed for the Store.

      Returns:
      supplyChannels

    • getProductSelections

      @NotNull @Valid @NotNull @Valid List<ProductSelectionSetting> getProductSelections()

      Controls availability of Products for this Store via Product Selections:

      • Leave empty if all Products in the Project should be available in this Store.
      • If only inactive Product Selections with IndividualExclusion ProductSelectionMode are provided, all the Products are available in this Store.
      • If all the Product Selections provided are inactive and there's at least a Product Selection of mode Individual, no Product is available in this Store.
      • If at least an active Product Selection is provided, only active Product Selections are considered to compute the availlability in this Store.
      Returns:
      productSelections

    • getCustom

      @Valid @Valid CustomFields getCustom()

      Custom fields for the Store.

      Specified by:
      getCustom in interface Customizable<Store>
      Returns:
      custom

    • setId

      void setId(String id)

      Unique ID of the Store.

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

    • setVersion

      void setVersion(Long version)

      Current version of the Store.

      Specified by:
      setVersion in interface BaseResource
      Parameters:
      version - value to be set

    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

      Date and time (UTC) the Store was initially created.

      Specified by:
      setCreatedAt in interface BaseResource
      Parameters:
      createdAt - value to be set

    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

      Date and time (UTC) the Store was last updated.

      Specified by:
      setLastModifiedAt in interface BaseResource
      Parameters:
      lastModifiedAt - value to be set

    • setLastModifiedBy

      void setLastModifiedBy(LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Store.

      Parameters:
      lastModifiedBy - value to be set

    • setCreatedBy

      void setCreatedBy(CreatedBy createdBy)

      IDs and references that created the Store.

      Parameters:
      createdBy - value to be set

    • setKey

      void setKey(String key)

      User-defined unique and immutable identifier for the Store.

      Parameters:
      key - value to be set

    • setName

      void setName(LocalizedString name)

      Name of the Store.

      Parameters:
      name - value to be set

    • setLanguages

      void setLanguages(String... languages)

      Languages configured for the Store.

      Parameters:
      languages - values to be set

    • setLanguages

      void setLanguages(List<String> languages)

      Languages configured for the Store.

      Parameters:
      languages - values to be set

    • setCountries

      void setCountries(StoreCountry... countries)

      Countries defined for the Store.

      Parameters:
      countries - values to be set

    • setCountries

      void setCountries(List<StoreCountry> countries)

      Countries defined for the Store.

      Parameters:
      countries - values to be set

    • setDistributionChannels

      void setDistributionChannels(ChannelReference... distributionChannels)

      Product Distribution Channels allowed for the Store.

      Parameters:
      distributionChannels - values to be set

    • setDistributionChannels

      void setDistributionChannels(List<ChannelReference> distributionChannels)

      Product Distribution Channels allowed for the Store.

      Parameters:
      distributionChannels - values to be set

    • setSupplyChannels

      void setSupplyChannels(ChannelReference... supplyChannels)

      Inventory Supply Channels allowed for the Store.

      Parameters:
      supplyChannels - values to be set

    • setSupplyChannels

      void setSupplyChannels(List<ChannelReference> supplyChannels)

      Inventory Supply Channels allowed for the Store.

      Parameters:
      supplyChannels - values to be set

    • setProductSelections

      void setProductSelections(ProductSelectionSetting... productSelections)

      Controls availability of Products for this Store via Product Selections:

      • Leave empty if all Products in the Project should be available in this Store.
      • If only inactive Product Selections with IndividualExclusion ProductSelectionMode are provided, all the Products are available in this Store.
      • If all the Product Selections provided are inactive and there's at least a Product Selection of mode Individual, no Product is available in this Store.
      • If at least an active Product Selection is provided, only active Product Selections are considered to compute the availlability in this Store.
      Parameters:
      productSelections - values to be set

    • setProductSelections

      void setProductSelections(List<ProductSelectionSetting> productSelections)

      Controls availability of Products for this Store via Product Selections:

      • Leave empty if all Products in the Project should be available in this Store.
      • If only inactive Product Selections with IndividualExclusion ProductSelectionMode are provided, all the Products are available in this Store.
      • If all the Product Selections provided are inactive and there's at least a Product Selection of mode Individual, no Product is available in this Store.
      • If at least an active Product Selection is provided, only active Product Selections are considered to compute the availlability in this Store.
      Parameters:
      productSelections - values to be set

    • setCustom

      void setCustom(CustomFields custom)

      Custom fields for the Store.

      Specified by:
      setCustom in interface Customizable<Store>
      Parameters:
      custom - value to be set

    • of

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

    • of

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

    • copyDeep

      Store copyDeep()
      Specified by:
      copyDeep in interface BaseResource

    • deepCopy

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

    • builder

      static StoreBuilder builder()
      builder factory method for Store
      Returns:
      builder

    • builder

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

    • withStore

      default <T> T withStore(Function<Store,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • referenceTypeId

      static ReferenceTypeId referenceTypeId()

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<Store> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference