com.elasticpath.xpf.connectivity.entity

Class XPFPromotionRule

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFPromotionRule

public class XPFPromotionRule
extends XPFEntity

Represents a promotion rule in the system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFPromotionRule.XPFPromotionRuleBuilder<C extends XPFPromotionRule,B extends XPFPromotionRule.XPFPromotionRuleBuilder<C,B>>

Nested classes/interfaces inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

XPFEntity.XPFEntityBuilder<C extends XPFEntity,B extends XPFEntity.XPFEntityBuilder<C,B>>

Constructor Summary

Constructors

Modifier	Constructor and Description
	XPFPromotionRule(@NonNull String code, @NonNull String name, @NonNull String type, String description, @NonNull String startDate, String endDate, XPFPromotionElementGroup rootConditionGroup, @NonNull XPFPromotionOperatorEnum conditionalOperator, @NonNull List<XPFPromotionElement> conditions, @NonNull List<XPFPromotionElement> actions, @NonNull XPFEntitySupplier<Map<Locale,String>> displayNames, @NonNull XPFEntitySupplier<Map<Locale,String>> carrotDescriptions)
protected	XPFPromotionRule(XPFPromotionRule.XPFPromotionRuleBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFPromotionRule.XPFPromotionRuleBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NonNull List<XPFPromotionElement>	getActions() The list of actions for the promotion rule.
Optional<String>	getCarrotDescription(Locale locale) Get localized carrot description for a locale with fallback behavior.
Map<Locale,String>	getCarrotDescriptions() Get the carrot descriptions.
@NonNull String	getCode() The unique code of the promotion rule.
@NonNull XPFPromotionOperatorEnum	getConditionalOperator() Deprecated. Use getRootConditionGroup().getOperator() instead.
@NonNull List<XPFPromotionElement>	getConditions() Deprecated. Use getRootConditionGroup().getConditions() as well as getRootConditionGroup().getChildGroups() instead.
String	getDescription() The description of the promotion rule.
Optional<String>	getDisplayName(Locale locale) Get localized display name for a locale with fallback behavior.
Map<Locale,String>	getDisplayNames() Get the display names.
String	getEndDate() The end date of the promotion rule.
@NonNull String	getName() The name of the promotion rule.
XPFPromotionElementGroup	getRootConditionGroup() The hierarchical root condition group of the promotion rule.
@NonNull String	getStartDate() The start date of the promotion rule.
@NonNull String	getType() The type of the promotion rule, which identifies the rule set and determines the promotion's context and behavior.
int	hashCode()
String	toString()

Methods inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

getCustomData, getCustomDataValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPFPromotionRule

protected XPFPromotionRule(XPFPromotionRule.XPFPromotionRuleBuilder<?,?> b)

XPFPromotionRule

public XPFPromotionRule(@NonNull
                        @NonNull String code,
                        @NonNull
                        @NonNull String name,
                        @NonNull
                        @NonNull String type,
                        String description,
                        @NonNull
                        @NonNull String startDate,
                        String endDate,
                        XPFPromotionElementGroup rootConditionGroup,
                        @NonNull
                        @NonNull XPFPromotionOperatorEnum conditionalOperator,
                        @NonNull
                        @NonNull List<XPFPromotionElement> conditions,
                        @NonNull
                        @NonNull List<XPFPromotionElement> actions,
                        @NonNull
                        @NonNull XPFEntitySupplier<Map<Locale,String>> displayNames,
                        @NonNull
                        @NonNull XPFEntitySupplier<Map<Locale,String>> carrotDescriptions)

Method Detail

getDisplayNames

public Map<Locale,String> getDisplayNames()

Get the display names.

Returns:

the display names

getDisplayName

public Optional<String> getDisplayName(Locale locale)

Get localized display name for a locale with fallback behavior.

Parameters:

locale - The locale to get a display name for.

Returns:

The display name as Optional.

getCarrotDescriptions

public Map<Locale,String> getCarrotDescriptions()

Get the carrot descriptions.

Returns:

the carrot descriptions

getCarrotDescription

public Optional<String> getCarrotDescription(Locale locale)

Get localized carrot description for a locale with fallback behavior.

Parameters:

locale - The locale to get a carrot description for.

Returns:

The carrot description as Optional.

builder

public static XPFPromotionRule.XPFPromotionRuleBuilder<?,?> builder()

getCode

@NonNull
public @NonNull String getCode()

The unique code of the promotion rule.

getName

@NonNull
public @NonNull String getName()

The name of the promotion rule.

getType

@NonNull
public @NonNull String getType()

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

getDescription

public String getDescription()

The description of the promotion rule.

getStartDate

@NonNull
public @NonNull String getStartDate()

The start date of the promotion rule.

getEndDate

public String getEndDate()

The end date of the promotion rule.

getRootConditionGroup

public XPFPromotionElementGroup getRootConditionGroup()

The hierarchical root condition group of the promotion rule. May be null for legacy promotions that have no conditions yet (no root group has been materialised). Plugins consuming the AND/OR tree should walk from this root via XPFPromotionElementGroup.getChildGroups() and XPFPromotionElementGroup.getConditions().

getConditionalOperator

@Deprecated
 @NonNull
public @NonNull XPFPromotionOperatorEnum getConditionalOperator()

Deprecated. Use getRootConditionGroup().getOperator() instead.

The conditional operator for the promotion rule. For new-style promotions with a root condition group, this field reflects getRootConditionGroup()'s operator and is retained for backward compatibility with consumers of the flat getConditions() list.

getConditions

@Deprecated
 @NonNull
public @NonNull List<XPFPromotionElement> getConditions()

Deprecated. Use getRootConditionGroup().getConditions() as well as getRootConditionGroup().getChildGroups() instead.

The flat list of conditions for the promotion rule. Retained for backward compatibility with plugins written against the pre-condition-groups model — every condition in the rule's group hierarchy appears here regardless of nesting depth. New consumers that need the AND/OR structure should read getRootConditionGroup() instead.

getActions

@NonNull
public @NonNull List<XPFPromotionElement> getActions()

The list of actions for the promotion rule.

toString

public String toString()

Overrides:

toString in class XPFEntity

equals

public boolean equals(Object o)

Overrides:

equals in class XPFEntity

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class XPFEntity

hashCode

public int hashCode()

Overrides:

hashCode in class XPFEntity