Package com.commercetools.importapi.models.prices

Class PriceImportBuilder

java.lang.Object

com.commercetools.importapi.models.prices.PriceImportBuilder

All Implemented Interfaces:

Builder<PriceImport>

public class PriceImportBuilder
extends Object
implements Builder<PriceImport>

PriceImportBuilder Example to create an instance using the builder pattern

     PriceImport priceImport = PriceImport.builder()
             .key("{key}")
             .value(valueBuilder -> valueBuilder)
             .productVariant(productVariantBuilder -> productVariantBuilder)
             .product(productBuilder -> productBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
PriceImportBuilder()

Method Summary

Modifier and Type	Method	Description
PriceImportBuilder	addTiers(Function<PriceTierBuilder,PriceTier> builder)	The tiered prices for this price.
PriceImport	build()	builds PriceImport with checking for non-null required values
PriceImport	buildUnchecked()	builds PriceImport without checking for non-null required values
PriceImportBuilder	channel(ChannelKeyReference channel)	Maps to Price.channel.
PriceImportBuilder	channel(Function<ChannelKeyReferenceBuilder,ChannelKeyReferenceBuilder> builder)	Maps to Price.channel.
PriceImportBuilder	country(String country)	Maps to Price.county.
PriceImportBuilder	custom(Custom custom)	Maps to Price.custom.
PriceImportBuilder	custom(Function<CustomBuilder,CustomBuilder> builder)	Maps to Price.custom.
PriceImportBuilder	customerGroup(CustomerGroupKeyReference customerGroup)	Maps to Price.customerGroup.
PriceImportBuilder	customerGroup(Function<CustomerGroupKeyReferenceBuilder,CustomerGroupKeyReferenceBuilder> builder)	Maps to Price.customerGroup.
PriceImportBuilder	discounted(DiscountedPrice discounted)	Sets a discounted price from an external service.
PriceImportBuilder	discounted(Function<DiscountedPriceBuilder,DiscountedPriceBuilder> builder)	Sets a discounted price from an external service.
ChannelKeyReference	getChannel()	Maps to Price.channel.
String	getCountry()	Maps to Price.county.
Custom	getCustom()	Maps to Price.custom.
CustomerGroupKeyReference	getCustomerGroup()	Maps to Price.customerGroup.
DiscountedPrice	getDiscounted()	Sets a discounted price from an external service.
String	getKey()	User-defined unique identifier for the Embedded Price.
ProductKeyReference	getProduct()	The Product which contains the productVariant.
ProductVariantKeyReference	getProductVariant()	The ProductVariant which contains this Embedded Price.
Boolean	getStaged()	Set to false to update both the current and staged projections of the Product with the new Price data. Leave empty or set to true to only update the staged projection.
List<PriceTier>	getTiers()	The tiered prices for this price.
ZonedDateTime	getValidFrom()	Maps to Price.validFrom.
ZonedDateTime	getValidUntil()	Maps to Price.validUntil.
TypedMoney	getValue()	Maps to Price.value.
PriceImportBuilder	key(String key)	User-defined unique identifier for the Embedded Price.
static PriceImportBuilder	of()	factory method for an instance of PriceImportBuilder
static PriceImportBuilder	of(PriceImport template)	create builder for PriceImport instance
PriceImportBuilder	plusTiers(PriceTier... tiers)	The tiered prices for this price.
PriceImportBuilder	plusTiers(Function<PriceTierBuilder,PriceTierBuilder> builder)	The tiered prices for this price.
PriceImportBuilder	product(ProductKeyReference product)	The Product which contains the productVariant.
PriceImportBuilder	product(Function<ProductKeyReferenceBuilder,ProductKeyReferenceBuilder> builder)	The Product which contains the productVariant.
PriceImportBuilder	productVariant(ProductVariantKeyReference productVariant)	The ProductVariant which contains this Embedded Price.
PriceImportBuilder	productVariant(Function<ProductVariantKeyReferenceBuilder,ProductVariantKeyReferenceBuilder> builder)	The ProductVariant which contains this Embedded Price.
PriceImportBuilder	setTiers(Function<PriceTierBuilder,PriceTier> builder)	The tiered prices for this price.
PriceImportBuilder	staged(Boolean staged)	Set to false to update both the current and staged projections of the Product with the new Price data. Leave empty or set to true to only update the staged projection.
PriceImportBuilder	tiers(PriceTier... tiers)	The tiered prices for this price.
PriceImportBuilder	tiers(List<PriceTier> tiers)	The tiered prices for this price.
PriceImportBuilder	validFrom(ZonedDateTime validFrom)	Maps to Price.validFrom.
PriceImportBuilder	validUntil(ZonedDateTime validUntil)	Maps to Price.validUntil.
PriceImportBuilder	value(TypedMoney value)	Maps to Price.value.
PriceImportBuilder	value(Function<TypedMoneyBuilder,Builder<? extends TypedMoney>> builder)	Maps to Price.value.
PriceImportBuilder	withChannel(Function<ChannelKeyReferenceBuilder,ChannelKeyReference> builder)	Maps to Price.channel.
PriceImportBuilder	withCustom(Function<CustomBuilder,Custom> builder)	Maps to Price.custom.
PriceImportBuilder	withCustomerGroup(Function<CustomerGroupKeyReferenceBuilder,CustomerGroupKeyReference> builder)	Maps to Price.customerGroup.
PriceImportBuilder	withDiscounted(Function<DiscountedPriceBuilder,DiscountedPrice> builder)	Sets a discounted price from an external service.
PriceImportBuilder	withProduct(Function<ProductKeyReferenceBuilder,ProductKeyReference> builder)	The Product which contains the productVariant.
PriceImportBuilder	withProductVariant(Function<ProductVariantKeyReferenceBuilder,ProductVariantKeyReference> builder)	The ProductVariant which contains this Embedded Price.
PriceImportBuilder	withTiers(Function<PriceTierBuilder,PriceTierBuilder> builder)	The tiered prices for this price.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PriceImportBuilder

public PriceImportBuilder()

Method Details

key

public PriceImportBuilder key(String key)

User-defined unique identifier for the Embedded Price. If a Price with this key exists on the specified productVariant, it is updated with the imported data.

Parameters:

key - value to be set

Returns:

Builder

value

public PriceImportBuilder value(TypedMoney value)

Maps to Price.value.

Parameters:

value - value to be set

Returns:

Builder

value

public PriceImportBuilder value(Function<TypedMoneyBuilder,Builder<? extends TypedMoney>> builder)

Maps to Price.value.

Parameters:

builder - function to build the value value

Returns:

Builder

country

public PriceImportBuilder country(@Nullable
 String country)

Maps to Price.county.

Parameters:

country - value to be set

Returns:

Builder

validFrom

public PriceImportBuilder validFrom(@Nullable
 ZonedDateTime validFrom)

Maps to Price.validFrom.

Parameters:

validFrom - value to be set

Returns:

Builder

validUntil

public PriceImportBuilder validUntil(@Nullable
 ZonedDateTime validUntil)

Maps to Price.validUntil.

Parameters:

validUntil - value to be set

Returns:

Builder

customerGroup

public PriceImportBuilder customerGroup(Function<CustomerGroupKeyReferenceBuilder,CustomerGroupKeyReferenceBuilder> builder)

Maps to Price.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.

Parameters:

builder - function to build the customerGroup value

Returns:

Builder

withCustomerGroup

public PriceImportBuilder withCustomerGroup(Function<CustomerGroupKeyReferenceBuilder,CustomerGroupKeyReference> builder)

Maps to Price.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.

Parameters:

builder - function to build the customerGroup value

Returns:

Builder

customerGroup

public PriceImportBuilder customerGroup(@Nullable
 CustomerGroupKeyReference customerGroup)

Maps to Price.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.

Parameters:

customerGroup - value to be set

Returns:

Builder

channel

public PriceImportBuilder channel(Function<ChannelKeyReferenceBuilder,ChannelKeyReferenceBuilder> builder)

Maps to Price.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.

Parameters:

builder - function to build the channel value

Returns:

Builder

withChannel

public PriceImportBuilder withChannel(Function<ChannelKeyReferenceBuilder,ChannelKeyReference> builder)

Maps to Price.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.

Parameters:

builder - function to build the channel value

Returns:

Builder

channel

public PriceImportBuilder channel(@Nullable
 ChannelKeyReference channel)

Maps to Price.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.

Parameters:

channel - value to be set

Returns:

Builder

discounted

public PriceImportBuilder discounted(Function<DiscountedPriceBuilder,DiscountedPriceBuilder> builder)

Sets a discounted price from an external service.

Parameters:

builder - function to build the discounted value

Returns:

Builder

withDiscounted

public PriceImportBuilder withDiscounted(Function<DiscountedPriceBuilder,DiscountedPrice> builder)

Sets a discounted price from an external service.

Parameters:

builder - function to build the discounted value

Returns:

Builder

discounted

public PriceImportBuilder discounted(@Nullable
 DiscountedPrice discounted)

Sets a discounted price from an external service.

Parameters:

discounted - value to be set

Returns:

Builder

staged

public PriceImportBuilder staged(@Nullable
 Boolean staged)

• Set to false to update both the current and staged projections of the Product with the new Price data.
• Leave empty or set to true to only update the staged projection.

Parameters:

staged - value to be set

Returns:

Builder

tiers

public PriceImportBuilder tiers(@Nullable
 PriceTier... tiers)

The tiered prices for this price.

Parameters:

tiers - value to be set

Returns:

Builder

tiers

public PriceImportBuilder tiers(@Nullable
 List<PriceTier> tiers)

The tiered prices for this price.

Parameters:

tiers - value to be set

Returns:

Builder

plusTiers

public PriceImportBuilder plusTiers(@Nullable
 PriceTier... tiers)

The tiered prices for this price.

Parameters:

tiers - value to be set

Returns:

Builder

plusTiers

public PriceImportBuilder plusTiers(Function<PriceTierBuilder,PriceTierBuilder> builder)

The tiered prices for this price.

Parameters:

builder - function to build the tiers value

Returns:

Builder

withTiers

public PriceImportBuilder withTiers(Function<PriceTierBuilder,PriceTierBuilder> builder)

The tiered prices for this price.

Parameters:

builder - function to build the tiers value

Returns:

Builder

addTiers

public PriceImportBuilder addTiers(Function<PriceTierBuilder,PriceTier> builder)

The tiered prices for this price.

Parameters:

builder - function to build the tiers value

Returns:

Builder

setTiers

public PriceImportBuilder setTiers(Function<PriceTierBuilder,PriceTier> builder)

The tiered prices for this price.

Parameters:

builder - function to build the tiers value

Returns:

Builder

custom

public PriceImportBuilder custom(Function<CustomBuilder,CustomBuilder> builder)

Maps to Price.custom.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public PriceImportBuilder withCustom(Function<CustomBuilder,Custom> builder)

Maps to Price.custom.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public PriceImportBuilder custom(@Nullable
 Custom custom)

Maps to Price.custom.

Parameters:

custom - value to be set

Returns:

Builder

productVariant

public PriceImportBuilder productVariant(Function<ProductVariantKeyReferenceBuilder,ProductVariantKeyReferenceBuilder> builder)

The ProductVariant which contains this Embedded Price. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.

Parameters:

builder - function to build the productVariant value

Returns:

Builder

withProductVariant

public PriceImportBuilder withProductVariant(Function<ProductVariantKeyReferenceBuilder,ProductVariantKeyReference> builder)

The ProductVariant which contains this Embedded Price. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.

Parameters:

builder - function to build the productVariant value

Returns:

Builder

productVariant

public PriceImportBuilder productVariant(ProductVariantKeyReference productVariant)

The ProductVariant which contains this Embedded Price. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.

Parameters:

productVariant - value to be set

Returns:

Builder

product

public PriceImportBuilder product(Function<ProductKeyReferenceBuilder,ProductKeyReferenceBuilder> builder)

The Product which contains the productVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.

Parameters:

builder - function to build the product value

Returns:

Builder

withProduct

public PriceImportBuilder withProduct(Function<ProductKeyReferenceBuilder,ProductKeyReference> builder)

The Product which contains the productVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.

Parameters:

builder - function to build the product value

Returns:

Builder

product

public PriceImportBuilder product(ProductKeyReference product)

The Product which contains the productVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.

Parameters:

product - value to be set

Returns:

Builder

getKey

public String getKey()

User-defined unique identifier for the Embedded Price. If a Price with this key exists on the specified productVariant, it is updated with the imported data.

Returns:

key

getValue

public TypedMoney getValue()

Maps to Price.value.

Returns:

value

getCountry

@Nullable
public String getCountry()

Maps to Price.county.

Returns:

country

getValidFrom

@Nullable
public ZonedDateTime getValidFrom()

Maps to Price.validFrom.

Returns:

validFrom

getValidUntil

@Nullable
public ZonedDateTime getValidUntil()

Maps to Price.validUntil.

Returns:

validUntil

getCustomerGroup

@Nullable
public CustomerGroupKeyReference getCustomerGroup()

Maps to Price.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.

Returns:

customerGroup

getChannel

@Nullable
public ChannelKeyReference getChannel()

Maps to Price.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.

Returns:

channel

getDiscounted

@Nullable
public DiscountedPrice getDiscounted()

Sets a discounted price from an external service.

Returns:

discounted

getStaged

@Nullable
public Boolean getStaged()

• Set to false to update both the current and staged projections of the Product with the new Price data.
• Leave empty or set to true to only update the staged projection.

Returns:

staged

getTiers

@Nullable
public List<PriceTier> getTiers()

The tiered prices for this price.

Returns:

tiers

getCustom

@Nullable
public Custom getCustom()

Maps to Price.custom.

Returns:

custom

getProductVariant

public ProductVariantKeyReference getProductVariant()

The ProductVariant which contains this Embedded Price. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.

Returns:

productVariant

getProduct

public ProductKeyReference getProduct()

The Product which contains the productVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.

Returns:

product

build

public PriceImport build()

builds PriceImport with checking for non-null required values

Specified by:

build in interface Builder<PriceImport>

Returns:

PriceImport

buildUnchecked

public PriceImport buildUnchecked()

builds PriceImport without checking for non-null required values

Returns:

PriceImport

of

public static PriceImportBuilder of()

factory method for an instance of PriceImportBuilder

Returns:

builder

of

public static PriceImportBuilder of(PriceImport template)

create builder for PriceImport instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder