Package org.broadleafcommerce.common.payment.dto

Class SubscriptionDTO<T>

java.lang.Object

org.broadleafcommerce.common.payment.dto.SubscriptionDTO<T>

public class SubscriptionDTO<T>
extends Object

Author:

Chad Harchar (charchar)

Many payment solutions allow you to set up subscriptions (recurring payments) with payment transactions.

The following DTO represent the usual parameters that you may wish to pass:

recurringAmount: the amount that you charge for every recurring payment frequency: the frequency of the recurring payment numberOfInstallments: the number of payments for this subscription startDate: the start date for this subscription

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	additionalFields
protected String	frequency
protected String	numberOfInstallments
protected T	parent
protected String	recurringAmount
protected String	startDate

Constructor Summary

Constructors

Constructor	Description
SubscriptionDTO()
SubscriptionDTO(T parent)

Method Summary

Modifier and Type	Method	Description
SubscriptionDTO<T>	additionalFields(String key, Object value)
T	done()
SubscriptionDTO<T>	frequency(String frequency)
Map<String,Object>	getAdditionalFields()
String	getFrequency()
String	getNumberOfInstallments()
String	getRecurringAmount()
String	getStartDate()
SubscriptionDTO<T>	numberOfInstallments(String numberOfInstallments)
SubscriptionDTO<T>	recurringAmount(String recurringAmount)
SubscriptionDTO<T>	startDate(String startDate)
boolean	subscriptionPopulated()

Methods inherited from class java.lang.Object

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

Field Details

parent

protected T parent

additionalFields

protected Map<String,Object> additionalFields

recurringAmount

protected String recurringAmount

frequency

protected String frequency

numberOfInstallments

protected String numberOfInstallments

startDate

protected String startDate

Constructor Details

SubscriptionDTO

public SubscriptionDTO()

SubscriptionDTO

public SubscriptionDTO(T parent)

Method Details

done

public T done()

additionalFields

public SubscriptionDTO<T> additionalFields(String key,
 Object value)

recurringAmount

public SubscriptionDTO<T> recurringAmount(String recurringAmount)

frequency

public SubscriptionDTO<T> frequency(String frequency)

numberOfInstallments

public SubscriptionDTO<T> numberOfInstallments(String numberOfInstallments)

startDate

public SubscriptionDTO<T> startDate(String startDate)

getAdditionalFields

public Map<String,Object> getAdditionalFields()

getRecurringAmount

public String getRecurringAmount()

getFrequency

public String getFrequency()

getNumberOfInstallments

public String getNumberOfInstallments()

getStartDate

public String getStartDate()

subscriptionPopulated

public boolean subscriptionPopulated()