Package com.commercetools.api.models.cart_discount

Interface CartDiscountValueGiftLineItemDraft

All Superinterfaces:

CartDiscountValueDraft, Draft<CartDiscountValueGiftLineItemDraft>

public interface CartDiscountValueGiftLineItemDraft
extends CartDiscountValueDraft, Draft<CartDiscountValueGiftLineItemDraft>

Can only be used in a CartDiscountDraft with no target specified. Hence, this type can not be used in the Change Value update action.

Example to create an instance using the builder pattern

     CartDiscountValueGiftLineItemDraft cartDiscountValueGiftLineItemDraft = CartDiscountValueGiftLineItemDraft.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 CartDiscountValueGiftLineItemDraft

Method Summary

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

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

getType, withCartDiscountValueDraft

Field Details

GIFT_LINE_ITEM

static final String GIFT_LINE_ITEM

discriminator value for CartDiscountValueGiftLineItemDraft

See Also:

• Constant Field Values

Method Details

getProduct

@NotNull
@Valid
@NotNull @Valid ProductResourceIdentifier getProduct()

ResourceIdentifier of a Product.

A Gift Line Item is added to a Cart even if the referenced Product is unpublished.

Returns:

product

getVariantId

@NotNull
@NotNull Long getVariantId()

ProductVariant of the Product.

Returns:

variantId

getSupplyChannel

@Valid
@Valid ChannelResourceIdentifier getSupplyChannel()

Channel must have the role InventorySupply.

Returns:

supplyChannel

getDistributionChannel

@Valid
@Valid ChannelResourceIdentifier getDistributionChannel()

Channel must have the role ProductDistribution.

Returns:

distributionChannel

setProduct

void setProduct(ProductResourceIdentifier product)

ResourceIdentifier of a Product.

A Gift Line Item is added to 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(ChannelResourceIdentifier supplyChannel)

Channel must have the role InventorySupply.

Parameters:

supplyChannel - value to be set

setDistributionChannel

void setDistributionChannel(ChannelResourceIdentifier distributionChannel)

Channel must have the role ProductDistribution.

Parameters:

distributionChannel - value to be set

of

static CartDiscountValueGiftLineItemDraft of()

factory method

Returns:

instance of CartDiscountValueGiftLineItemDraft

of

static CartDiscountValueGiftLineItemDraft of(CartDiscountValueGiftLineItemDraft template)

factory method to create a shallow copy CartDiscountValueGiftLineItemDraft

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartDiscountValueGiftLineItemDraft copyDeep()

Specified by:

copyDeep in interface CartDiscountValueDraft

deepCopy

@Nullable
static CartDiscountValueGiftLineItemDraft deepCopy(@Nullable
 CartDiscountValueGiftLineItemDraft template)

factory method to create a deep copy of CartDiscountValueGiftLineItemDraft

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartDiscountValueGiftLineItemDraftBuilder builder()

builder factory method for CartDiscountValueGiftLineItemDraft

Returns:

builder

builder

static CartDiscountValueGiftLineItemDraftBuilder builder(CartDiscountValueGiftLineItemDraft template)

create builder for CartDiscountValueGiftLineItemDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartDiscountValueGiftLineItemDraft

default <T> T withCartDiscountValueGiftLineItemDraft(Function<CartDiscountValueGiftLineItemDraft,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<CartDiscountValueGiftLineItemDraft> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference