Package com.commercetools.api.models.discount_code

Class DiscountCodeBuilder

java.lang.Object

com.commercetools.api.models.discount_code.DiscountCodeBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<DiscountCode>

public class DiscountCodeBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<DiscountCode>

DiscountCodeBuilder Example to create an instance using the builder pattern

     DiscountCode discountCode = DiscountCode.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .code("{code}")
             .plusCartDiscounts(cartDiscountsBuilder -> cartDiscountsBuilder)
             .isActive(true)
             .plusReferences(referencesBuilder -> referencesBuilder)
             .plusGroups(groupsBuilder -> groupsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
DiscountCodeBuilder()

Method Summary

Modifier and Type	Method	Description
DiscountCodeBuilder	addCartDiscounts(Function<CartDiscountReferenceBuilder,CartDiscountReference> builder)	Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
DiscountCodeBuilder	applicationVersion(Long applicationVersion)	Used and managed by the API and must not be used in customer logic.
DiscountCode	build()	builds DiscountCode with checking for non-null required values
DiscountCode	buildUnchecked()	builds DiscountCode without checking for non-null required values
DiscountCodeBuilder	cartDiscounts(CartDiscountReference... cartDiscounts)	Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
DiscountCodeBuilder	cartDiscounts(List<CartDiscountReference> cartDiscounts)	Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
DiscountCodeBuilder	cartPredicate(String cartPredicate)	DiscountCode can only be applied to Carts that match this predicate.
DiscountCodeBuilder	code(String code)	User-defined unique identifier of the DiscountCode added to the Cart to apply the related CartDiscounts.
DiscountCodeBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the DiscountCode was initially created.
DiscountCodeBuilder	createdBy(CreatedBy createdBy)	Present on resources created after 1 February 2019 except for events not tracked.
DiscountCodeBuilder	createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
DiscountCodeBuilder	custom(CustomFields custom)	Custom Fields of the DiscountCode.
DiscountCodeBuilder	custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	Custom Fields of the DiscountCode.
DiscountCodeBuilder	description(LocalizedString description)	Description of the DiscountCode.
DiscountCodeBuilder	description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Description of the DiscountCode.
Long	getApplicationVersion()	Used and managed by the API and must not be used in customer logic.
List<CartDiscountReference>	getCartDiscounts()	Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
String	getCartPredicate()	DiscountCode can only be applied to Carts that match this predicate.
String	getCode()	User-defined unique identifier of the DiscountCode added to the Cart to apply the related CartDiscounts.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the DiscountCode was initially created.
CreatedBy	getCreatedBy()	Present on resources created after 1 February 2019 except for events not tracked.
CustomFields	getCustom()	Custom Fields of the DiscountCode.
LocalizedString	getDescription()	Description of the DiscountCode.
List<String>	getGroups()	Groups to which the DiscountCode belongs to.
String	getId()	Unique identifier of the DiscountCode.
Boolean	getIsActive()	Indicates if the DiscountCode is active and can be applied to the Cart.
ZonedDateTime	getLastModifiedAt()	Date and time (UTC) the DiscountCode was last updated.
LastModifiedBy	getLastModifiedBy()	Present on resources created after 1 February 2019 except for events not tracked.
Long	getMaxApplications()	Number of times the DiscountCode can be applied.
Long	getMaxApplicationsPerCustomer()	Number of times the DiscountCode can be applied per Customer (anonymous Carts are not supported).
LocalizedString	getName()	Name of the DiscountCode.
List<Reference>	getReferences()	Array generated from the Cart predicate.
ZonedDateTime	getValidFrom()	Date and time (UTC) from which the DiscountCode is effective.
ZonedDateTime	getValidUntil()	Date and time (UTC) until which the DiscountCode is effective.
Long	getVersion()	Current version of the DiscountCode.
DiscountCodeBuilder	groups(String... groups)	Groups to which the DiscountCode belongs to.
DiscountCodeBuilder	groups(List<String> groups)	Groups to which the DiscountCode belongs to.
DiscountCodeBuilder	id(String id)	Unique identifier of the DiscountCode.
DiscountCodeBuilder	isActive(Boolean isActive)	Indicates if the DiscountCode is active and can be applied to the Cart.
DiscountCodeBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	Date and time (UTC) the DiscountCode was last updated.
DiscountCodeBuilder	lastModifiedBy(LastModifiedBy lastModifiedBy)	Present on resources created after 1 February 2019 except for events not tracked.
DiscountCodeBuilder	lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)	Present on resources created after 1 February 2019 except for events not tracked.
DiscountCodeBuilder	maxApplications(Long maxApplications)	Number of times the DiscountCode can be applied.
DiscountCodeBuilder	maxApplicationsPerCustomer(Long maxApplicationsPerCustomer)	Number of times the DiscountCode can be applied per Customer (anonymous Carts are not supported).
DiscountCodeBuilder	name(LocalizedString name)	Name of the DiscountCode.
DiscountCodeBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the DiscountCode.
static DiscountCodeBuilder	of()	factory method for an instance of DiscountCodeBuilder
static DiscountCodeBuilder	of(DiscountCode template)	create builder for DiscountCode instance
DiscountCodeBuilder	plusCartDiscounts(CartDiscountReference... cartDiscounts)	Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
DiscountCodeBuilder	plusCartDiscounts(Function<CartDiscountReferenceBuilder,CartDiscountReferenceBuilder> builder)	Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
DiscountCodeBuilder	plusGroups(String... groups)	Groups to which the DiscountCode belongs to.
DiscountCodeBuilder	plusReferences(Reference... references)	Array generated from the Cart predicate.
DiscountCodeBuilder	plusReferences(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)	Array generated from the Cart predicate.
DiscountCodeBuilder	references(Reference... references)	Array generated from the Cart predicate.
DiscountCodeBuilder	references(List<Reference> references)	Array generated from the Cart predicate.
DiscountCodeBuilder	setCartDiscounts(Function<CartDiscountReferenceBuilder,CartDiscountReference> builder)	Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
DiscountCodeBuilder	validFrom(ZonedDateTime validFrom)	Date and time (UTC) from which the DiscountCode is effective.
DiscountCodeBuilder	validUntil(ZonedDateTime validUntil)	Date and time (UTC) until which the DiscountCode is effective.
DiscountCodeBuilder	version(Long version)	Current version of the DiscountCode.
DiscountCodeBuilder	withCartDiscounts(Function<CartDiscountReferenceBuilder,CartDiscountReferenceBuilder> builder)	Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
DiscountCodeBuilder	withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
DiscountCodeBuilder	withCustom(Function<CustomFieldsBuilder,CustomFields> builder)	Custom Fields of the DiscountCode.
DiscountCodeBuilder	withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Description of the DiscountCode.
DiscountCodeBuilder	withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)	Present on resources created after 1 February 2019 except for events not tracked.
DiscountCodeBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the DiscountCode.
DiscountCodeBuilder	withReferences(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)	Array generated from the Cart predicate.

Methods inherited from class java.lang.Object

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

Constructor Details

DiscountCodeBuilder

public DiscountCodeBuilder()

Method Details

id

public DiscountCodeBuilder id(String id)

Unique identifier of the DiscountCode.

Parameters:

id - value to be set

Returns:

Builder

version

public DiscountCodeBuilder version(Long version)

Current version of the DiscountCode.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public DiscountCodeBuilder createdAt(ZonedDateTime createdAt)

Date and time (UTC) the DiscountCode was initially created.

Parameters:

createdAt - value to be set

Returns:

Builder

lastModifiedAt

public DiscountCodeBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

Date and time (UTC) the DiscountCode was last updated.

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

lastModifiedBy

public DiscountCodeBuilder lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

withLastModifiedBy

public DiscountCodeBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the lastModifiedBy value

Returns:

Builder

lastModifiedBy

public DiscountCodeBuilder lastModifiedBy(@Nullable
 LastModifiedBy lastModifiedBy)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

lastModifiedBy - value to be set

Returns:

Builder

createdBy

public DiscountCodeBuilder createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

withCreatedBy

public DiscountCodeBuilder withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

builder - function to build the createdBy value

Returns:

Builder

createdBy

public DiscountCodeBuilder createdBy(@Nullable
 CreatedBy createdBy)

Present on resources created after 1 February 2019 except for events not tracked.

Parameters:

createdBy - value to be set

Returns:

Builder

name

public DiscountCodeBuilder name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Name of the DiscountCode.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

public DiscountCodeBuilder withName(Function<LocalizedStringBuilder,LocalizedString> builder)

Name of the DiscountCode.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public DiscountCodeBuilder name(@Nullable
 LocalizedString name)

Name of the DiscountCode.

Parameters:

name - value to be set

Returns:

Builder

description

public DiscountCodeBuilder description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Description of the DiscountCode.

Parameters:

builder - function to build the description value

Returns:

Builder

withDescription

public DiscountCodeBuilder withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)

Description of the DiscountCode.

Parameters:

builder - function to build the description value

Returns:

Builder

description

public DiscountCodeBuilder description(@Nullable
 LocalizedString description)

Description of the DiscountCode.

Parameters:

description - value to be set

Returns:

Builder

code

public DiscountCodeBuilder code(String code)

User-defined unique identifier of the DiscountCode added to the Cart to apply the related CartDiscounts.

Parameters:

code - value to be set

Returns:

Builder

cartDiscounts

public DiscountCodeBuilder cartDiscounts(CartDiscountReference... cartDiscounts)

Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.

Parameters:

cartDiscounts - value to be set

Returns:

Builder

cartDiscounts

public DiscountCodeBuilder cartDiscounts(List<CartDiscountReference> cartDiscounts)

Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.

Parameters:

cartDiscounts - value to be set

Returns:

Builder

plusCartDiscounts

public DiscountCodeBuilder plusCartDiscounts(CartDiscountReference... cartDiscounts)

Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.

Parameters:

cartDiscounts - value to be set

Returns:

Builder

plusCartDiscounts

public DiscountCodeBuilder plusCartDiscounts(Function<CartDiscountReferenceBuilder,CartDiscountReferenceBuilder> builder)

Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.

Parameters:

builder - function to build the cartDiscounts value

Returns:

Builder

withCartDiscounts

public DiscountCodeBuilder withCartDiscounts(Function<CartDiscountReferenceBuilder,CartDiscountReferenceBuilder> builder)

Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.

Parameters:

builder - function to build the cartDiscounts value

Returns:

Builder

addCartDiscounts

public DiscountCodeBuilder addCartDiscounts(Function<CartDiscountReferenceBuilder,CartDiscountReference> builder)

Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.

Parameters:

builder - function to build the cartDiscounts value

Returns:

Builder

setCartDiscounts

public DiscountCodeBuilder setCartDiscounts(Function<CartDiscountReferenceBuilder,CartDiscountReference> builder)

Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.

Parameters:

builder - function to build the cartDiscounts value

Returns:

Builder

cartPredicate

public DiscountCodeBuilder cartPredicate(@Nullable
 String cartPredicate)

DiscountCode can only be applied to Carts that match this predicate.

Parameters:

cartPredicate - value to be set

Returns:

Builder

isActive

public DiscountCodeBuilder isActive(Boolean isActive)

Indicates if the DiscountCode is active and can be applied to the Cart.

Parameters:

isActive - value to be set

Returns:

Builder

references

public DiscountCodeBuilder references(Reference... references)

Array generated from the Cart predicate. It contains the references of all the resources that are addressed in the predicate.

Parameters:

references - value to be set

Returns:

Builder

references

public DiscountCodeBuilder references(List<Reference> references)

Array generated from the Cart predicate. It contains the references of all the resources that are addressed in the predicate.

Parameters:

references - value to be set

Returns:

Builder

plusReferences

public DiscountCodeBuilder plusReferences(Reference... references)

Array generated from the Cart predicate. It contains the references of all the resources that are addressed in the predicate.

Parameters:

references - value to be set

Returns:

Builder

plusReferences

public DiscountCodeBuilder plusReferences(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)

Array generated from the Cart predicate. It contains the references of all the resources that are addressed in the predicate.

Parameters:

builder - function to build the references value

Returns:

Builder

withReferences

public DiscountCodeBuilder withReferences(Function<ReferenceBuilder,io.vrap.rmf.base.client.Builder<? extends Reference>> builder)

Array generated from the Cart predicate. It contains the references of all the resources that are addressed in the predicate.

Parameters:

builder - function to build the references value

Returns:

Builder

maxApplications

public DiscountCodeBuilder maxApplications(@Nullable
 Long maxApplications)

Number of times the DiscountCode can be applied. DiscountCode application is counted at the time of Order creation or edit. However, Order cancellation or deletion does not decrement the count.

Parameters:

maxApplications - value to be set

Returns:

Builder

maxApplicationsPerCustomer

public DiscountCodeBuilder maxApplicationsPerCustomer(@Nullable
 Long maxApplicationsPerCustomer)

Number of times the DiscountCode can be applied per Customer (anonymous Carts are not supported). DiscountCode application is counted at the time of Order creation or edit. However, Order cancellation or deletion does not decrement the count.

Parameters:

maxApplicationsPerCustomer - value to be set

Returns:

Builder

custom

public DiscountCodeBuilder custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)

Custom Fields of the DiscountCode.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public DiscountCodeBuilder withCustom(Function<CustomFieldsBuilder,CustomFields> builder)

Custom Fields of the DiscountCode.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public DiscountCodeBuilder custom(@Nullable
 CustomFields custom)

Custom Fields of the DiscountCode.

Parameters:

custom - value to be set

Returns:

Builder

groups

public DiscountCodeBuilder groups(String... groups)

Groups to which the DiscountCode belongs to.

Parameters:

groups - value to be set

Returns:

Builder

groups

public DiscountCodeBuilder groups(List<String> groups)

Groups to which the DiscountCode belongs to.

Parameters:

groups - value to be set

Returns:

Builder

plusGroups

public DiscountCodeBuilder plusGroups(String... groups)

Groups to which the DiscountCode belongs to.

Parameters:

groups - value to be set

Returns:

Builder

validFrom

public DiscountCodeBuilder validFrom(@Nullable
 ZonedDateTime validFrom)

Date and time (UTC) from which the DiscountCode is effective.

Parameters:

validFrom - value to be set

Returns:

Builder

validUntil

public DiscountCodeBuilder validUntil(@Nullable
 ZonedDateTime validUntil)

Date and time (UTC) until which the DiscountCode is effective.

Parameters:

validUntil - value to be set

Returns:

Builder

applicationVersion

public DiscountCodeBuilder applicationVersion(@Nullable
 Long applicationVersion)

Used and managed by the API and must not be used in customer logic. The value can change at any time due to internal and external factors.

Parameters:

applicationVersion - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the DiscountCode.

Returns:

id

getVersion

public Long getVersion()

Current version of the DiscountCode.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

Date and time (UTC) the DiscountCode was initially created.

Returns:

createdAt

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

Date and time (UTC) the DiscountCode was last updated.

Returns:

lastModifiedAt

getLastModifiedBy

@Nullable
public LastModifiedBy getLastModifiedBy()

Present on resources created after 1 February 2019 except for events not tracked.

Returns:

lastModifiedBy

getCreatedBy

@Nullable
public CreatedBy getCreatedBy()

Present on resources created after 1 February 2019 except for events not tracked.

Returns:

createdBy

getName

@Nullable
public LocalizedString getName()

Name of the DiscountCode.

Returns:

name

getDescription

@Nullable
public LocalizedString getDescription()

Description of the DiscountCode.

Returns:

description

getCode

public String getCode()

User-defined unique identifier of the DiscountCode added to the Cart to apply the related CartDiscounts.

Returns:

code

getCartDiscounts

public List<CartDiscountReference> getCartDiscounts()

Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.

Returns:

cartDiscounts

getCartPredicate

@Nullable
public String getCartPredicate()

DiscountCode can only be applied to Carts that match this predicate.

Returns:

cartPredicate

getIsActive

public Boolean getIsActive()

Indicates if the DiscountCode is active and can be applied to the Cart.

Returns:

isActive

getReferences

public List<Reference> getReferences()

Array generated from the Cart predicate. It contains the references of all the resources that are addressed in the predicate.

Returns:

references

getMaxApplications

@Nullable
public Long getMaxApplications()

Number of times the DiscountCode can be applied. DiscountCode application is counted at the time of Order creation or edit. However, Order cancellation or deletion does not decrement the count.

Returns:

maxApplications

getMaxApplicationsPerCustomer

@Nullable
public Long getMaxApplicationsPerCustomer()

Number of times the DiscountCode can be applied per Customer (anonymous Carts are not supported). DiscountCode application is counted at the time of Order creation or edit. However, Order cancellation or deletion does not decrement the count.

Returns:

maxApplicationsPerCustomer

getCustom

@Nullable
public CustomFields getCustom()

Custom Fields of the DiscountCode.

Returns:

custom

getGroups

public List<String> getGroups()

Groups to which the DiscountCode belongs to.

Returns:

groups

getValidFrom

@Nullable
public ZonedDateTime getValidFrom()

Date and time (UTC) from which the DiscountCode is effective.

Returns:

validFrom

getValidUntil

@Nullable
public ZonedDateTime getValidUntil()

Date and time (UTC) until which the DiscountCode is effective.

Returns:

validUntil

getApplicationVersion

@Nullable
public Long getApplicationVersion()

Used and managed by the API and must not be used in customer logic. The value can change at any time due to internal and external factors.

Returns:

applicationVersion

build

public DiscountCode build()

builds DiscountCode with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<DiscountCode>

Returns:

DiscountCode

buildUnchecked

public DiscountCode buildUnchecked()

builds DiscountCode without checking for non-null required values

Returns:

DiscountCode

of

public static DiscountCodeBuilder of()

factory method for an instance of DiscountCodeBuilder

Returns:

builder

of

public static DiscountCodeBuilder of(DiscountCode template)

create builder for DiscountCode instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder