Package com.commercetools.api.models.recurring_order

Interface ApplicableRecurrencePoliciesDraft

All Superinterfaces:

Draft<ApplicableRecurrencePoliciesDraft>, RecurringOrderScopeDraft

public interface ApplicableRecurrencePoliciesDraft
extends RecurringOrderScopeDraft, Draft<ApplicableRecurrencePoliciesDraft>

Applies Cart Discounts to recurring Orders that match the Recurrence Policies.

Example to create an instance using the builder pattern

     ApplicableRecurrencePoliciesDraft applicableRecurrencePoliciesDraft = ApplicableRecurrencePoliciesDraft.builder()
             .plusRecurrencePolicies(recurrencePoliciesBuilder -> recurrencePoliciesBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICABLE_RECURRENCE_POLICIES	discriminator value for ApplicableRecurrencePoliciesDraft

Method Summary

Modifier and Type	Method	Description
static ApplicableRecurrencePoliciesDraftBuilder	builder()	builder factory method for ApplicableRecurrencePoliciesDraft
static ApplicableRecurrencePoliciesDraftBuilder	builder(ApplicableRecurrencePoliciesDraft template)	create builder for ApplicableRecurrencePoliciesDraft instance
ApplicableRecurrencePoliciesDraft	copyDeep()
static ApplicableRecurrencePoliciesDraft	deepCopy(ApplicableRecurrencePoliciesDraft template)	factory method to create a deep copy of ApplicableRecurrencePoliciesDraft
@NotNull @Valid List<RecurrencePolicyResourceIdentifier>	getRecurrencePolicies()	Recurrence Policies for which the Cart Discount is valid.
@NotNull String	getType()
static ApplicableRecurrencePoliciesDraft	of()	factory method
static ApplicableRecurrencePoliciesDraft	of(ApplicableRecurrencePoliciesDraft template)	factory method to create a shallow copy ApplicableRecurrencePoliciesDraft
void	setRecurrencePolicies(RecurrencePolicyResourceIdentifier... recurrencePolicies)	Recurrence Policies for which the Cart Discount is valid.
void	setRecurrencePolicies(List<RecurrencePolicyResourceIdentifier> recurrencePolicies)	Recurrence Policies for which the Cart Discount is valid.
static com.fasterxml.jackson.core.type.TypeReference<ApplicableRecurrencePoliciesDraft>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withApplicableRecurrencePoliciesDraft(Function<ApplicableRecurrencePoliciesDraft,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.recurring_order.RecurringOrderScopeDraft

withRecurringOrderScopeDraft

Field Details

APPLICABLE_RECURRENCE_POLICIES

static final String APPLICABLE_RECURRENCE_POLICIES

discriminator value for ApplicableRecurrencePoliciesDraft

See Also:

• Constant Field Values

Method Details

getType

@NotNull
@NotNull String getType()

Specified by:

getType in interface RecurringOrderScopeDraft

Returns:

type

getRecurrencePolicies

@NotNull
@Valid
@NotNull @Valid List<RecurrencePolicyResourceIdentifier> getRecurrencePolicies()

Recurrence Policies for which the Cart Discount is valid.

If a Recurrence Policy does not exist, a ReferencedResourceNotFound error will be returned.

If fewer or more Recurrence Policies are provided, an InvalidOperation error will be returned.

Returns:

recurrencePolicies

setRecurrencePolicies

void setRecurrencePolicies(RecurrencePolicyResourceIdentifier... recurrencePolicies)

Recurrence Policies for which the Cart Discount is valid.

If a Recurrence Policy does not exist, a ReferencedResourceNotFound error will be returned.

If fewer or more Recurrence Policies are provided, an InvalidOperation error will be returned.

Parameters:

recurrencePolicies - values to be set

setRecurrencePolicies

void setRecurrencePolicies(List<RecurrencePolicyResourceIdentifier> recurrencePolicies)

Recurrence Policies for which the Cart Discount is valid.

If a Recurrence Policy does not exist, a ReferencedResourceNotFound error will be returned.

If fewer or more Recurrence Policies are provided, an InvalidOperation error will be returned.

Parameters:

recurrencePolicies - values to be set

of

static ApplicableRecurrencePoliciesDraft of()

factory method

Returns:

instance of ApplicableRecurrencePoliciesDraft

of

static ApplicableRecurrencePoliciesDraft of(ApplicableRecurrencePoliciesDraft template)

factory method to create a shallow copy ApplicableRecurrencePoliciesDraft

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ApplicableRecurrencePoliciesDraft copyDeep()

Specified by:

copyDeep in interface RecurringOrderScopeDraft

deepCopy

@Nullable
static ApplicableRecurrencePoliciesDraft deepCopy(@Nullable
 ApplicableRecurrencePoliciesDraft template)

factory method to create a deep copy of ApplicableRecurrencePoliciesDraft

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ApplicableRecurrencePoliciesDraftBuilder builder()

builder factory method for ApplicableRecurrencePoliciesDraft

Returns:

builder

builder

static ApplicableRecurrencePoliciesDraftBuilder builder(ApplicableRecurrencePoliciesDraft template)

create builder for ApplicableRecurrencePoliciesDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withApplicableRecurrencePoliciesDraft

default <T> T withApplicableRecurrencePoliciesDraft(Function<ApplicableRecurrencePoliciesDraft,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<ApplicableRecurrencePoliciesDraft> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference