com.elasticpath.xpf.connectivity.entity

Class XPFPaymentSchedule

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFPaymentSchedule

public class XPFPaymentSchedule
extends XPFEntity

Represents a schedule for recurring payments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFPaymentSchedule.XPFPaymentScheduleBuilder<C extends XPFPaymentSchedule,B extends XPFPaymentSchedule.XPFPaymentScheduleBuilder<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
	XPFPaymentSchedule(@NonNull String name, @NonNull XPFUnitOfMeasure frequency, @NonNull XPFUnitOfMeasure scheduleStart, @NonNull XPFUnitOfMeasure duration, int ordering, boolean rollover)
protected	XPFPaymentSchedule(XPFPaymentSchedule.XPFPaymentScheduleBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFPaymentSchedule.XPFPaymentScheduleBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NonNull XPFUnitOfMeasure	getDuration() The duration of the schedule.
@NonNull XPFUnitOfMeasure	getFrequency() The frequency of the schedule.
@NonNull String	getName() The name of the schedule.
int	getOrdering() The ordinal value of this schedule within a collection of other schedules.
@NonNull XPFUnitOfMeasure	getScheduleStart() The start of the schedule.
int	hashCode()
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

XPFPaymentSchedule

protected XPFPaymentSchedule(XPFPaymentSchedule.XPFPaymentScheduleBuilder<?,?> b)

XPFPaymentSchedule

public XPFPaymentSchedule(@NonNull
                          @NonNull String name,
                          @NonNull
                          @NonNull XPFUnitOfMeasure frequency,
                          @NonNull
                          @NonNull XPFUnitOfMeasure scheduleStart,
                          @NonNull
                          @NonNull XPFUnitOfMeasure duration,
                          int ordering,
                          boolean rollover)

Method Detail

builder

public static XPFPaymentSchedule.XPFPaymentScheduleBuilder<?,?> builder()

getName

@NonNull
public @NonNull String getName()

The name of the schedule.

getFrequency

@NonNull
public @NonNull XPFUnitOfMeasure getFrequency()

The frequency of the schedule. This uses XPFUnitOfMeasure to allow for multiples of a given period, for example 2 MONTH to represent bi-monthly, 3 MONTH to represent quarterly, etc.

getScheduleStart

@NonNull
public @NonNull XPFUnitOfMeasure getScheduleStart()

The start of the schedule.

getDuration

@NonNull
public @NonNull XPFUnitOfMeasure getDuration()

The duration of the schedule.

getOrdering

public int getOrdering()

The ordinal value of this schedule within a collection of other schedules.

isRollover

public boolean isRollover()

The rollover flag. When TRUE, then this schedule will include estimated price periods beyond the schedule's duration.

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