com.elasticpath.xpf.connectivity.entity

Class XPFPricePeriod

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFPricePeriod

public class XPFPricePeriod
extends XPFEntity

Represents a price over a specific billing cycle period.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFPricePeriod.XPFPricePeriodBuilder<C extends XPFPricePeriod,B extends XPFPricePeriod.XPFPricePeriodBuilder<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
	XPFPricePeriod(@NonNull Integer start, Integer end, boolean rollover, boolean estimated, @NonNull BigDecimal amount, @NonNull Currency currency)
protected	XPFPricePeriod(XPFPricePeriod.XPFPricePeriodBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFPricePeriod.XPFPricePeriodBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NonNull BigDecimal	getAmount() The price amount applicable for the period.
@NonNull Currency	getCurrency() The currency.
Integer	getEnd() The end point of the period.
@NonNull Integer	getStart() The starting point of the period.
int	hashCode()
boolean	isEstimated() The estimated flag.
boolean	isRollover() The rollover flag.
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

XPFPricePeriod

protected XPFPricePeriod(XPFPricePeriod.XPFPricePeriodBuilder<?,?> b)

XPFPricePeriod

public XPFPricePeriod(@NonNull
                      @NonNull Integer start,
                      Integer end,
                      boolean rollover,
                      boolean estimated,
                      @NonNull
                      @NonNull BigDecimal amount,
                      @NonNull
                      @NonNull Currency currency)

Method Detail

builder

public static XPFPricePeriod.XPFPricePeriodBuilder<?,?> builder()

getStart

@NonNull
public @NonNull Integer getStart()

The starting point of the period. Related to the frequency property of XPFPaymentSchedule.

getEnd

public Integer getEnd()

The end point of the period. Related to the frequency property of XPFPaymentSchedule. When rollover is TRUE then this property should not be set.

isRollover

public boolean isRollover()

The rollover flag. When TRUE, then this price period will have no end.

isEstimated

public boolean isEstimated()

The estimated flag. When TRUE, then the amount of this price period is considered to be estimated and subject to change.

getAmount

@NonNull
public @NonNull BigDecimal getAmount()

The price amount applicable for the period.

getCurrency

@NonNull
public @NonNull Currency getCurrency()

The currency.

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