com.elasticpath.xpf.connectivity.entity

Class XPFCoupon

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFCoupon

public class XPFCoupon
extends XPFEntity

Coupon entity.

Constructor Summary

Constructors

Constructor and Description
XPFCoupon(@NonNull String guid, @NonNull String couponCode, boolean suspended, @NonNull XPFEntitySupplier<XPFPromotionRule> rule, @NonNull XPFCouponUsageLimitTypeEnum limitType, Long usageLimit, boolean limitedDuration, Long durationInDays, boolean multiUsePerOrder)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NonNull String	getCouponCode() The coupon code.
Long	getDurationInDays() The number of days, from when the coupon is first used, that the coupon is active for.
@NonNull String	getGuid() The coupon GUID.
@NonNull XPFCouponUsageLimitTypeEnum	getLimitType() The coupon usage limit type.
XPFPromotionRule	getRule() Returns the promotion rule for this coupon.
Long	getUsageLimit() The limit on how many times this can be used.
int	hashCode()
boolean	isLimitedDuration() The limited duration.
boolean	isMultiUsePerOrder() The multi use per order.
boolean	isSuspended() Indicates if the coupon is suspended.
String	toString()

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

getCustomData

Methods inherited from class java.lang.Object

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

Constructor Detail

XPFCoupon

public XPFCoupon(@NonNull
                 @NonNull String guid,
                 @NonNull
                 @NonNull String couponCode,
                 boolean suspended,
                 @NonNull
                 @NonNull XPFEntitySupplier<XPFPromotionRule> rule,
                 @NonNull
                 @NonNull XPFCouponUsageLimitTypeEnum limitType,
                 Long usageLimit,
                 boolean limitedDuration,
                 Long durationInDays,
                 boolean multiUsePerOrder)

Method Detail

getRule

@LazyLoaded
public XPFPromotionRule getRule()

Returns the promotion rule for this coupon.

Returns:

the promotion rule for this coupon

getGuid

@NonNull
public @NonNull String getGuid()

The coupon GUID.

getCouponCode

@NonNull
public @NonNull String getCouponCode()

The coupon code.

isSuspended

public boolean isSuspended()

Indicates if the coupon is suspended.

getLimitType

@NonNull
public @NonNull XPFCouponUsageLimitTypeEnum getLimitType()

The coupon usage limit type.

getUsageLimit

public Long getUsageLimit()

The limit on how many times this can be used. How the limit is interpreted is defined by `limitType`.

isLimitedDuration

public boolean isLimitedDuration()

The limited duration.

getDurationInDays

public Long getDurationInDays()

The number of days, from when the coupon is first used, that the coupon is active for.

isMultiUsePerOrder

public boolean isMultiUsePerOrder()

The multi use per order.

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