Interface OverlappingStandalonePriceValidityError
- All Superinterfaces:
ErrorObject
Returned when a given Price validity period conflicts with an existing one. Every Standalone Price associated with the same SKU and with the same combination of currency, country, Customer Group, and Channel, must have non-overlapping validity periods (validFrom
and validUntil
).
The error is returned as a failed response to the Create StandalonePrice request.
Example to create an instance using the builder pattern
OverlappingStandalonePriceValidityError overlappingStandalonePriceValidityError = OverlappingStandalonePriceValidityError.builder()
.message("{message}")
.conflictingStandalonePrice(conflictingStandalonePriceBuilder -> conflictingStandalonePriceBuilder)
.sku("{sku}")
.currency("{currency}")
.build()
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
discriminator value for OverlappingStandalonePriceValidityError -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for OverlappingStandalonePriceValidityErrorcreate builder for OverlappingStandalonePriceValidityError instancefactory method to create a deep copy of OverlappingStandalonePriceValidityError@Valid ChannelResourceIdentifier
Channel for which the Standalone Price is valid.@NotNull String
getCode()
Error identifier.@NotNull @Valid StandalonePriceReference
Reference to the conflicting Standalone Price.Date and time (UTC) from which the conflicting Standalone Price is valid.Date and time (UTC) until which the conflicting Standalone Price is valid.Country code of the geographic location.@NotNull String
Currency code of the country.CustomerGroup for which the Standalone Price is valid.@NotNull String
Two standalone prices have overlapping validity periods."
@NotNull String
getSku()
SKU of the ProductVariant to which the conflicting Standalone Price is associated.Date and time (UTC) from which the Standalone Price is valid.Date and time (UTC) until which the Standalone Price is valid.of()
factory methodof
(OverlappingStandalonePriceValidityError template) factory method to create a shallow copy OverlappingStandalonePriceValidityErrorvoid
setChannel
(ChannelResourceIdentifier channel) Channel for which the Standalone Price is valid.void
setConflictingStandalonePrice
(StandalonePriceReference conflictingStandalonePrice) Reference to the conflicting Standalone Price.void
setConflictingValidFrom
(ZonedDateTime conflictingValidFrom) Date and time (UTC) from which the conflicting Standalone Price is valid.void
setConflictingValidUntil
(ZonedDateTime conflictingValidUntil) Date and time (UTC) until which the conflicting Standalone Price is valid.void
setCountry
(String country) Country code of the geographic location.void
setCurrency
(String currency) Currency code of the country.void
setCustomerGroup
(CustomerGroupResourceIdentifier customerGroup) CustomerGroup for which the Standalone Price is valid.void
setMessage
(String message) Two standalone prices have overlapping validity periods."
void
SKU of the ProductVariant to which the conflicting Standalone Price is associated.void
setValidFrom
(ZonedDateTime validFrom) Date and time (UTC) from which the Standalone Price is valid.void
setValidUntil
(ZonedDateTime validUntil) Date and time (UTC) until which the Standalone Price is valid.static com.fasterxml.jackson.core.type.TypeReference<OverlappingStandalonePriceValidityError>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
withOverlappingStandalonePriceValidityError
(Function<OverlappingStandalonePriceValidityError, T> helper) accessor map functionMethods inherited from interface com.commercetools.api.models.error.ErrorObject
setValue, values, withErrorObject
-
Field Details
-
OVERLAPPING_STANDALONE_PRICE_VALIDITY
discriminator value for OverlappingStandalonePriceValidityError- See Also:
-
-
Method Details
-
getCode
Description copied from interface:ErrorObject
Error identifier.
- Specified by:
getCode
in interfaceErrorObject
- Returns:
- code
-
getMessage
Two standalone prices have overlapping validity periods."
- Specified by:
getMessage
in interfaceErrorObject
- Returns:
- message
-
getConflictingStandalonePrice
Reference to the conflicting Standalone Price.
- Returns:
- conflictingStandalonePrice
-
getSku
SKU of the ProductVariant to which the conflicting Standalone Price is associated.
- Returns:
- sku
-
getCurrency
Currency code of the country.
- Returns:
- currency
-
getCountry
String getCountry()Country code of the geographic location.
- Returns:
- country
-
getCustomerGroup
CustomerGroup for which the Standalone Price is valid.
- Returns:
- customerGroup
-
getChannel
Channel for which the Standalone Price is valid.
- Returns:
- channel
-
getValidFrom
ZonedDateTime getValidFrom()Date and time (UTC) from which the Standalone Price is valid.
- Returns:
- validFrom
-
getValidUntil
ZonedDateTime getValidUntil()Date and time (UTC) until which the Standalone Price is valid.
- Returns:
- validUntil
-
getConflictingValidFrom
ZonedDateTime getConflictingValidFrom()Date and time (UTC) from which the conflicting Standalone Price is valid.
- Returns:
- conflictingValidFrom
-
getConflictingValidUntil
ZonedDateTime getConflictingValidUntil()Date and time (UTC) until which the conflicting Standalone Price is valid.
- Returns:
- conflictingValidUntil
-
setMessage
Two standalone prices have overlapping validity periods."
- Specified by:
setMessage
in interfaceErrorObject
- Parameters:
message
- value to be set
-
setConflictingStandalonePrice
Reference to the conflicting Standalone Price.
- Parameters:
conflictingStandalonePrice
- value to be set
-
setSku
SKU of the ProductVariant to which the conflicting Standalone Price is associated.
- Parameters:
sku
- value to be set
-
setCurrency
Currency code of the country.
- Parameters:
currency
- value to be set
-
setCountry
Country code of the geographic location.
- Parameters:
country
- value to be set
-
setCustomerGroup
CustomerGroup for which the Standalone Price is valid.
- Parameters:
customerGroup
- value to be set
-
setChannel
Channel for which the Standalone Price is valid.
- Parameters:
channel
- value to be set
-
setValidFrom
Date and time (UTC) from which the Standalone Price is valid.
- Parameters:
validFrom
- value to be set
-
setValidUntil
Date and time (UTC) until which the Standalone Price is valid.
- Parameters:
validUntil
- value to be set
-
setConflictingValidFrom
Date and time (UTC) from which the conflicting Standalone Price is valid.
- Parameters:
conflictingValidFrom
- value to be set
-
setConflictingValidUntil
Date and time (UTC) until which the conflicting Standalone Price is valid.
- Parameters:
conflictingValidUntil
- value to be set
-
of
factory method- Returns:
- instance of OverlappingStandalonePriceValidityError
-
of
factory method to create a shallow copy OverlappingStandalonePriceValidityError- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
@Nullable static OverlappingStandalonePriceValidityError deepCopy(@Nullable OverlappingStandalonePriceValidityError template) factory method to create a deep copy of OverlappingStandalonePriceValidityError- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for OverlappingStandalonePriceValidityError- Returns:
- builder
-
builder
static OverlappingStandalonePriceValidityErrorBuilder builder(OverlappingStandalonePriceValidityError template) create builder for OverlappingStandalonePriceValidityError instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withOverlappingStandalonePriceValidityError
default <T> T withOverlappingStandalonePriceValidityError(Function<OverlappingStandalonePriceValidityError, 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<OverlappingStandalonePriceValidityError> typeReference()gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-