Package com.commercetools.api.models.cart_discount

Interface CartDiscountValueGiftLineItem

All Superinterfaces:

CartDiscountValue, CartDiscountValueGiftLineItemMixin, CartDiscountValueMixin, GenericCartDiscountValueMixin<CartDiscountValueGiftLineItemDraft>

public interface CartDiscountValueGiftLineItem
extends CartDiscountValue, CartDiscountValueGiftLineItemMixin

CartDiscountValueGiftLineItem Example to create an instance using the builder pattern

     CartDiscountValueGiftLineItem cartDiscountValueGiftLineItem = CartDiscountValueGiftLineItem.builder()
             .product(productBuilder -> productBuilder)
             .variantId(0.3)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GIFT_LINE_ITEM	discriminator value for CartDiscountValueGiftLineItem

Method Summary

Modifier and Type	Method	Description
static CartDiscountValueGiftLineItemBuilder	builder()	builder factory method for CartDiscountValueGiftLineItem
static CartDiscountValueGiftLineItemBuilder	builder(CartDiscountValueGiftLineItem template)	create builder for CartDiscountValueGiftLineItem instance
CartDiscountValueGiftLineItem	copyDeep()
static CartDiscountValueGiftLineItem	deepCopy(CartDiscountValueGiftLineItem template)	factory method to create a deep copy of CartDiscountValueGiftLineItem
@Valid ChannelReference	getDistributionChannel()	Channel must have the ChannelRoleEnum ProductDistribution.
@NotNull @Valid ProductReference	getProduct()	Reference to a Product.
@Valid ChannelReference	getSupplyChannel()	Channel must have the ChannelRoleEnum InventorySupply.
@NotNull Long	getVariantId()	ProductVariant of the Product.
static CartDiscountValueGiftLineItem	of()	factory method
static CartDiscountValueGiftLineItem	of(CartDiscountValueGiftLineItem template)	factory method to create a shallow copy CartDiscountValueGiftLineItem
void	setDistributionChannel(ChannelReference distributionChannel)	Channel must have the ChannelRoleEnum ProductDistribution.
void	setProduct(ProductReference product)	Reference to a Product.
void	setSupplyChannel(ChannelReference supplyChannel)	Channel must have the ChannelRoleEnum InventorySupply.
void	setVariantId(Long variantId)	ProductVariant of the Product.
static com.fasterxml.jackson.core.type.TypeReference<CartDiscountValueGiftLineItem>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartDiscountValueGiftLineItem(Function<CartDiscountValueGiftLineItem,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.cart_discount.CartDiscountValue

getType, withCartDiscountValue

Methods inherited from interface com.commercetools.api.models.cart_discount.CartDiscountValueGiftLineItemMixin

toDraft, toDraftBuilder

Field Details

GIFT_LINE_ITEM

static final String GIFT_LINE_ITEM

discriminator value for CartDiscountValueGiftLineItem

See Also:

• Constant Field Values

Method Details

getProduct

@NotNull
@Valid
@NotNull @Valid ProductReference getProduct()

Reference to a Product.

A Gift Line Item can be present on a Cart even if the referenced Product is unpublished.

Specified by:

getProduct in interface CartDiscountValueGiftLineItemMixin

Returns:

product

getVariantId

@NotNull
@NotNull Long getVariantId()

ProductVariant of the Product.

Specified by:

getVariantId in interface CartDiscountValueGiftLineItemMixin

Returns:

variantId

getSupplyChannel

@Valid
@Valid ChannelReference getSupplyChannel()

Channel must have the ChannelRoleEnum InventorySupply.

Specified by:

getSupplyChannel in interface CartDiscountValueGiftLineItemMixin

Returns:

supplyChannel

getDistributionChannel

@Valid
@Valid ChannelReference getDistributionChannel()

Channel must have the ChannelRoleEnum ProductDistribution.

Specified by:

getDistributionChannel in interface CartDiscountValueGiftLineItemMixin

Returns:

distributionChannel

setProduct

void setProduct(ProductReference product)

Reference to a Product.

A Gift Line Item can be present on a Cart even if the referenced Product is unpublished.

Parameters:

product - value to be set

setVariantId

void setVariantId(Long variantId)

ProductVariant of the Product.

Parameters:

variantId - value to be set

setSupplyChannel

void setSupplyChannel(ChannelReference supplyChannel)

Channel must have the ChannelRoleEnum InventorySupply.

Parameters:

supplyChannel - value to be set

setDistributionChannel

void setDistributionChannel(ChannelReference distributionChannel)

Channel must have the ChannelRoleEnum ProductDistribution.

Parameters:

distributionChannel - value to be set

of

static CartDiscountValueGiftLineItem of()

factory method

Returns:

instance of CartDiscountValueGiftLineItem

of

static CartDiscountValueGiftLineItem of(CartDiscountValueGiftLineItem template)

factory method to create a shallow copy CartDiscountValueGiftLineItem

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartDiscountValueGiftLineItem copyDeep()

Specified by:

copyDeep in interface CartDiscountValue

deepCopy

@Nullable
static CartDiscountValueGiftLineItem deepCopy(@Nullable
 CartDiscountValueGiftLineItem template)

factory method to create a deep copy of CartDiscountValueGiftLineItem

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartDiscountValueGiftLineItemBuilder builder()

builder factory method for CartDiscountValueGiftLineItem

Returns:

builder

builder

static CartDiscountValueGiftLineItemBuilder builder(CartDiscountValueGiftLineItem template)

create builder for CartDiscountValueGiftLineItem instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartDiscountValueGiftLineItem

default <T> T withCartDiscountValueGiftLineItem(Function<CartDiscountValueGiftLineItem,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<CartDiscountValueGiftLineItem> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference