com.elasticpath.xpf.connectivity.entity

Class XPFPromotionRule.XPFPromotionRuleBuilder

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFPromotionRule.XPFPromotionRuleBuilder

Enclosing class:

XPFPromotionRule

public static class XPFPromotionRule.XPFPromotionRuleBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
XPFPromotionRule.XPFPromotionRuleBuilder	actions(@NonNull List<XPFPromotionElement> actions) The list of actions for the promotion rule.
XPFPromotionRule	build()
XPFPromotionRule.XPFPromotionRuleBuilder	carrotDescriptions(@NonNull XPFEntitySupplier<Map<Locale,String>> carrotDescriptions) The carrot descriptions.
XPFPromotionRule.XPFPromotionRuleBuilder	code(@NonNull String code) The unique code of the promotion rule.
XPFPromotionRule.XPFPromotionRuleBuilder	conditionalOperator(@NonNull XPFPromotionOperatorEnum conditionalOperator) The conditional operator for the promotion rule.
XPFPromotionRule.XPFPromotionRuleBuilder	conditions(@NonNull List<XPFPromotionElement> conditions) The list of conditions for the promotion rule.
XPFPromotionRule.XPFPromotionRuleBuilder	description(String description) The description of the promotion rule.
XPFPromotionRule.XPFPromotionRuleBuilder	displayNames(@NonNull XPFEntitySupplier<Map<Locale,String>> displayNames) The rule display name.
XPFPromotionRule.XPFPromotionRuleBuilder	endDate(String endDate) The end date of the promotion rule.
XPFPromotionRule.XPFPromotionRuleBuilder	name(@NonNull String name) The name of the promotion rule.
XPFPromotionRule.XPFPromotionRuleBuilder	startDate(@NonNull String startDate) The start date of the promotion rule.
String	toString()
XPFPromotionRule.XPFPromotionRuleBuilder	type(@NonNull String type) The type of the promotion rule, which identifies the rule set and determines the promotion's context and behavior.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

code

public XPFPromotionRule.XPFPromotionRuleBuilder code(@NonNull
                                                     @NonNull String code)

The unique code of the promotion rule.

Returns:

this.

name

public XPFPromotionRule.XPFPromotionRuleBuilder name(@NonNull
                                                     @NonNull String name)

The name of the promotion rule.

Returns:

this.

type

public XPFPromotionRule.XPFPromotionRuleBuilder type(@NonNull
                                                     @NonNull String type)

The type of the promotion rule, which identifies the rule set and determines the promotion's context and behavior. This field determines where and how the promotion can be applied.

This field is expected to contain one of these values:

• CART - For shopping cart promotions, applied during cart operations
• CART_LINE - For cart line promotions, applied during cart operations
• CATALOG_BROWSE_SCENARIO - For catalog/browsing promotions, applied during product browsing

This type influences:

• The scope and context of promotion application
• How the promotion is processed by the rule engine
• Available conditions and actions for the promotion

Returns:

this.

description

public XPFPromotionRule.XPFPromotionRuleBuilder description(String description)

The description of the promotion rule.

Returns:

this.

startDate

public XPFPromotionRule.XPFPromotionRuleBuilder startDate(@NonNull
                                                          @NonNull String startDate)

The start date of the promotion rule.

Returns:

this.

endDate

public XPFPromotionRule.XPFPromotionRuleBuilder endDate(String endDate)

The end date of the promotion rule.

Returns:

this.

conditionalOperator

public XPFPromotionRule.XPFPromotionRuleBuilder conditionalOperator(@NonNull
                                                                    @NonNull XPFPromotionOperatorEnum conditionalOperator)

The conditional operator for the promotion rule.

Returns:

this.

conditions

public XPFPromotionRule.XPFPromotionRuleBuilder conditions(@NonNull
                                                           @NonNull List<XPFPromotionElement> conditions)

The list of conditions for the promotion rule.

Returns:

this.

actions

public XPFPromotionRule.XPFPromotionRuleBuilder actions(@NonNull
                                                        @NonNull List<XPFPromotionElement> actions)

The list of actions for the promotion rule.

Returns:

this.

displayNames

public XPFPromotionRule.XPFPromotionRuleBuilder displayNames(@NonNull
                                                             @NonNull XPFEntitySupplier<Map<Locale,String>> displayNames)

The rule display name.

Returns:

this.

carrotDescriptions

public XPFPromotionRule.XPFPromotionRuleBuilder carrotDescriptions(@NonNull
                                                                   @NonNull XPFEntitySupplier<Map<Locale,String>> carrotDescriptions)

The carrot descriptions.

Returns:

this.

build

public XPFPromotionRule build()

toString

public String toString()

Overrides:

toString in class Object