Interface Store
- All Superinterfaces:
BaseResource
,Customizable<Store>
,DomainResource<Store>
,Identifiable<Store>
,Referencable<Store>
,ResourceIdentifiable<Store>
,StoreMixin
,Versioned<Store>
,WithKey
- All Known Implementing Classes:
StoreImpl
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 Summary
Modifier and TypeMethodDescriptionstatic StoreBuilder
builder()
builder factory method for Storestatic StoreBuilder
create builder for Store instancestatic Store
factory method to create a deep copy of Store@NotNull @Valid List<StoreCountry>
Countries defined for the Store.@NotNull ZonedDateTime
Date and time (UTC) the Store was initially created.@Valid CreatedBy
Present on resources created after 1 February 2019 except for events not tracked.@Valid CustomFields
Custom fields for the Store.@NotNull @Valid List<ChannelReference>
Product Distribution Channels allowed for the Store.@NotNull String
getId()
Unique ID of the Store.@NotNull String
getKey()
User-defined unique and immutable identifier for the Store.Languages configured for the Store.@NotNull ZonedDateTime
Date and time (UTC) the Store was last updated.@Valid LastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.@Valid LocalizedString
getName()
Name of the Store.@NotNull @Valid List<ProductSelectionSetting>
Controls availability of Products for this Store via Product Selections:@NotNull @Valid List<ChannelReference>
Inventory Supply Channels allowed for the Store.@NotNull Long
Current version of the Store.static Store
of()
factory methodstatic Store
factory method to create a shallow copy Storestatic ReferenceTypeId
void
setCountries
(StoreCountry... countries) Countries defined for the Store.void
setCountries
(List<StoreCountry> countries) Countries defined for the Store.void
setCreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the Store was initially created.void
setCreatedBy
(CreatedBy createdBy) Present on resources created after 1 February 2019 except for events not tracked.void
setCustom
(CustomFields custom) Custom fields for the Store.void
setDistributionChannels
(ChannelReference... distributionChannels) Product Distribution Channels allowed for the Store.void
setDistributionChannels
(List<ChannelReference> distributionChannels) Product Distribution Channels allowed for the Store.void
Unique ID of the Store.void
User-defined unique and immutable identifier for the Store.void
setLanguages
(String... languages) Languages configured for the Store.void
setLanguages
(List<String> languages) Languages configured for the Store.void
setLastModifiedAt
(ZonedDateTime lastModifiedAt) Date and time (UTC) the Store was last updated.void
setLastModifiedBy
(LastModifiedBy lastModifiedBy) Present on resources created after 1 February 2019 except for events not tracked.void
setName
(LocalizedString name) Name of the Store.void
setProductSelections
(ProductSelectionSetting... productSelections) Controls availability of Products for this Store via Product Selections:void
setProductSelections
(List<ProductSelectionSetting> productSelections) Controls availability of Products for this Store via Product Selections:void
setSupplyChannels
(ChannelReference... supplyChannels) Inventory Supply Channels allowed for the Store.void
setSupplyChannels
(List<ChannelReference> supplyChannels) Inventory Supply Channels allowed for the Store.void
setVersion
(Long version) Current version of the Store.static com.fasterxml.jackson.core.type.TypeReference<Store>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.common.BaseResource
withBaseResource
Methods inherited from interface com.commercetools.api.models.Customizable
unwrapCustomizable
Methods inherited from interface com.commercetools.api.models.DomainResource
get
Methods inherited from interface com.commercetools.api.models.store.StoreMixin
toReference, toResourceIdentifier
-
Method Details
-
getId
Unique ID of the Store.
- Specified by:
getId
in interfaceBaseResource
- Specified by:
getId
in interfaceDomainResource<Store>
- Specified by:
getId
in interfaceIdentifiable<Store>
- Specified by:
getId
in interfaceVersioned<Store>
- Returns:
- id
-
getVersion
Current version of the Store.
- Specified by:
getVersion
in interfaceBaseResource
- Specified by:
getVersion
in interfaceDomainResource<Store>
- Specified by:
getVersion
in interfaceVersioned<Store>
- Returns:
- version
-
getCreatedAt
Date and time (UTC) the Store was initially created.
- Specified by:
getCreatedAt
in interfaceBaseResource
- Returns:
- createdAt
-
getLastModifiedAt
Date and time (UTC) the Store was last updated.
- Specified by:
getLastModifiedAt
in interfaceBaseResource
- Returns:
- lastModifiedAt
-
getLastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Returns:
- lastModifiedBy
-
getCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Returns:
- createdBy
-
getKey
User-defined unique and immutable identifier for the Store.
-
getName
Name of the Store.
- Returns:
- name
-
getLanguages
Languages configured for the Store.
- Returns:
- languages
-
getCountries
Countries defined for the Store.
- Returns:
- countries
-
getDistributionChannels
Product Distribution Channels allowed for the Store.
- Returns:
- distributionChannels
-
getSupplyChannels
Inventory Supply Channels allowed for the Store.
- Returns:
- supplyChannels
-
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 withIndividualExclusion
ProductSelectionMode are provided, all the Products are availlable in this Store. - If all the Product Selections provided are
inactive
and there's at least a Product Selection of modeIndividual
, no Product is availlable in this Store. - If at least an
active
Product Selection is provided, onlyactive
Product Selections are considered to compute the availlability in this Store.
- Returns:
- productSelections
-
getCustom
Custom fields for the Store.
- Specified by:
getCustom
in interfaceCustomizable<Store>
- Returns:
- custom
-
setId
Unique ID of the Store.
- Specified by:
setId
in interfaceBaseResource
- Parameters:
id
- value to be set
-
setVersion
Current version of the Store.
- Specified by:
setVersion
in interfaceBaseResource
- Parameters:
version
- value to be set
-
setCreatedAt
Date and time (UTC) the Store was initially created.
- Specified by:
setCreatedAt
in interfaceBaseResource
- Parameters:
createdAt
- value to be set
-
setLastModifiedAt
Date and time (UTC) the Store was last updated.
- Specified by:
setLastModifiedAt
in interfaceBaseResource
- Parameters:
lastModifiedAt
- value to be set
-
setLastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
lastModifiedBy
- value to be set
-
setCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
createdBy
- value to be set
-
setKey
User-defined unique and immutable identifier for the Store.
- Parameters:
key
- value to be set
-
setName
Name of the Store.
- Parameters:
name
- value to be set
-
setLanguages
Languages configured for the Store.
- Parameters:
languages
- values to be set
-
setLanguages
Languages configured for the Store.
- Parameters:
languages
- values to be set
-
setCountries
Countries defined for the Store.
- Parameters:
countries
- values to be set
-
setCountries
Countries defined for the Store.
- Parameters:
countries
- values to be set
-
setDistributionChannels
Product Distribution Channels allowed for the Store.
- Parameters:
distributionChannels
- values to be set
-
setDistributionChannels
Product Distribution Channels allowed for the Store.
- Parameters:
distributionChannels
- values to be set
-
setSupplyChannels
Inventory Supply Channels allowed for the Store.
- Parameters:
supplyChannels
- values to be set
-
setSupplyChannels
Inventory Supply Channels allowed for the Store.
- Parameters:
supplyChannels
- values to be set
-
setProductSelections
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 withIndividualExclusion
ProductSelectionMode are provided, all the Products are availlable in this Store. - If all the Product Selections provided are
inactive
and there's at least a Product Selection of modeIndividual
, no Product is availlable in this Store. - If at least an
active
Product Selection is provided, onlyactive
Product Selections are considered to compute the availlability in this Store.
- Parameters:
productSelections
- values to be set
-
setProductSelections
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 withIndividualExclusion
ProductSelectionMode are provided, all the Products are availlable in this Store. - If all the Product Selections provided are
inactive
and there's at least a Product Selection of modeIndividual
, no Product is availlable in this Store. - If at least an
active
Product Selection is provided, onlyactive
Product Selections are considered to compute the availlability in this Store.
- Parameters:
productSelections
- values to be set
-
setCustom
Custom fields for the Store.
- Specified by:
setCustom
in interfaceCustomizable<Store>
- Parameters:
custom
- value to be set
-
of
factory method- Returns:
- instance of Store
-
of
factory method to create a shallow copy Store- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
factory method to create a deep copy of Store- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for Store- Returns:
- builder
-
builder
create builder for Store instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withStore
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
referenceTypeId
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-