com.ning.billing.recurly.model

Class Coupon

java.lang.Object

com.ning.billing.recurly.model.RecurlyObject

com.ning.billing.recurly.model.Coupon

public class Coupon
extends RecurlyObject

Class that represents the Concept of a Coupon within the Recurly API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Coupon.DiscountType
static class	Coupon.Duration
static class	Coupon.FreeTrialUnit
static class	Coupon.RedemptionResource
static class	Coupon.TemporalUnit
static class	Coupon.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUPON_RESOURCE
static String	GENERATE_RESOURCE
static String	UNIQUE_CODES_RESOURCE

Fields inherited from class com.ning.billing.recurly.model.RecurlyObject

NIL_STR, NIL_VAL

Constructor Summary

Constructors

Constructor and Description
Coupon()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Integer	getAppliesForMonths()
Boolean	getAppliesToAllPlans()
Boolean	getAppliesToNonPlanCharges()
String	getCouponCode() Gets the coupon code for a Coupon
org.joda.time.DateTime	getCreatedAt()
String	getDescription()
RecurlyUnitCurrency	getDiscountInCents()
Integer	getDiscountPercent() Gets the percentage discount for a coupon
Coupon.DiscountType	getDiscountType() Gets the discount type associated with the Coupon
Coupon.Duration	getDuration()
Integer	getFreeTrialAmount()
Coupon.FreeTrialUnit	getFreeTrialUnit()
Long	getId()
String	getInvoiceDescription()
Integer	getMaxRedemptions()
Integer	getMaxRedemptionsPerAccount()
String	getName() Gets the name of the Coupon
Integer	getNumberOfUniqueCodes()
PlanCodes	getPlanCodes()
org.joda.time.DateTime	getRedeemByDate()
Coupon.RedemptionResource	getRedemptionResource()
Boolean	getSingleUse()
String	getState()
Integer	getTemporalAmount()
Coupon.TemporalUnit	getTemporalUnit()
Coupon.Type	getType()
String	getUniqueCodeTemplate()
org.joda.time.DateTime	getUpdatedAt()
int	hashCode()
void	setAppliesForMonths(Object appliesForMonths)
void	setAppliesToAllPlans(Object appliesToAllPlans)
void	setAppliesToNonPlanCharges(Object appliesToNonPlanCharges)
void	setCouponCode(Object couponCode) Sets the coupon code for the Coupon
void	setCreatedAt(Object createdAt)
void	setDescription(Object description)
void	setDiscountInCents(Object discountInCents)
void	setDiscountPercent(Object discountPercent)
void	setDiscountType(Object discountType) Sets the discount type for a Coupon
void	setDuration(Object duration)
void	setFreeTrialAmount(Object freeTrialAmount)
void	setFreeTrialUnit(Object freeTrialUnit)
void	setId(Object id)
void	setInvoiceDescription(Object invoiceDescription)
void	setMaxRedemptions(Object maxRedemptions)
void	setMaxRedemptionsPerAccount(Object maxRedemptionsPerAccount)
void	setName(Object name) Sets the name of the Coupon
void	setNumberOfUniqueCodes(Integer numberOfUniqueCodes)
void	setPlanCodes(PlanCodes planCodes)
void	setRedeemByDate(Object redeemByDate)
void	setRedemptionResource(Object redemptionResource)
void	setSingleUse(Object singleUse)
void	setState(Object state)
void	setTemporalAmount(Object temporalAmount)
void	setTemporalUnit(Object temporalUnit)
void	setType(Coupon.Type type)
void	setUniqueCodeTemplate(Object uniqueCodeTemplate)
void	setUpdatedAt(Object updatedAt)
String	toString()

Methods inherited from class com.ning.billing.recurly.model.RecurlyObject

bigDecimalOrNull, booleanOrNull, dateTimeOrNull, enumOrNull, enumOrNull, getHref, integerOrNull, isNull, longOrNull, newXmlMapper, setHref, setRecurlyClient, stringOrNull

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

COUPON_RESOURCE

public static final String COUPON_RESOURCE

See Also:

Constant Field Values

GENERATE_RESOURCE

public static final String GENERATE_RESOURCE

See Also:

Constant Field Values

UNIQUE_CODES_RESOURCE

public static final String UNIQUE_CODES_RESOURCE

See Also:

Constant Field Values

Constructor Detail

Coupon

public Coupon()

Method Detail

getPlanCodes

public PlanCodes getPlanCodes()

setPlanCodes

public void setPlanCodes(PlanCodes planCodes)

setId

public void setId(Object id)

getId

public Long getId()

getState

public String getState()

setState

public void setState(Object state)

getName

public String getName()

Gets the name of the Coupon

Returns:

The Coupon name

setName

public void setName(Object name)

Sets the name of the Coupon

Parameters:

name - The Name that is to be given to the Coupon

getCouponCode

public String getCouponCode()

Gets the coupon code for a Coupon

Returns:

The coupon code for the Coupon

setCouponCode

public void setCouponCode(Object couponCode)

Sets the coupon code for the Coupon

Parameters:

couponCode - The coupon code

setDiscountType

public void setDiscountType(Object discountType)

Sets the discount type for a Coupon

Parameters:

discountType -

getDiscountType

public Coupon.DiscountType getDiscountType()

Gets the discount type associated with the Coupon

Returns:

the DiscountType

getDiscountPercent

public Integer getDiscountPercent()

Gets the percentage discount for a coupon

Returns:

The percentage

setDiscountPercent

public void setDiscountPercent(Object discountPercent)

getRedeemByDate

public org.joda.time.DateTime getRedeemByDate()

setRedeemByDate

public void setRedeemByDate(Object redeemByDate)

getAppliesForMonths

public Integer getAppliesForMonths()

setAppliesForMonths

public void setAppliesForMonths(Object appliesForMonths)

getMaxRedemptions

public Integer getMaxRedemptions()

setMaxRedemptions

public void setMaxRedemptions(Object maxRedemptions)

getSingleUse

public Boolean getSingleUse()

setSingleUse

public void setSingleUse(Object singleUse)

getDiscountInCents

public RecurlyUnitCurrency getDiscountInCents()

setDiscountInCents

public void setDiscountInCents(Object discountInCents)

getAppliesToAllPlans

public Boolean getAppliesToAllPlans()

setAppliesToAllPlans

public void setAppliesToAllPlans(Object appliesToAllPlans)

getFreeTrialUnit

public Coupon.FreeTrialUnit getFreeTrialUnit()

setFreeTrialUnit

public void setFreeTrialUnit(Object freeTrialUnit)

getFreeTrialAmount

public Integer getFreeTrialAmount()

setFreeTrialAmount

public void setFreeTrialAmount(Object freeTrialAmount)

getCreatedAt

public org.joda.time.DateTime getCreatedAt()

setCreatedAt

public void setCreatedAt(Object createdAt)

getUpdatedAt

public org.joda.time.DateTime getUpdatedAt()

setUpdatedAt

public void setUpdatedAt(Object updatedAt)

getDescription

public String getDescription()

setDescription

public void setDescription(Object description)

getInvoiceDescription

public String getInvoiceDescription()

setInvoiceDescription

public void setInvoiceDescription(Object invoiceDescription)

getDuration

public Coupon.Duration getDuration()

setDuration

public void setDuration(Object duration)

getTemporalUnit

public Coupon.TemporalUnit getTemporalUnit()

setTemporalUnit

public void setTemporalUnit(Object temporalUnit)

getTemporalAmount

public Integer getTemporalAmount()

setTemporalAmount

public void setTemporalAmount(Object temporalAmount)

getAppliesToNonPlanCharges

public Boolean getAppliesToNonPlanCharges()

setAppliesToNonPlanCharges

public void setAppliesToNonPlanCharges(Object appliesToNonPlanCharges)

getRedemptionResource

public Coupon.RedemptionResource getRedemptionResource()

setRedemptionResource

public void setRedemptionResource(Object redemptionResource)

getMaxRedemptionsPerAccount

public Integer getMaxRedemptionsPerAccount()

setMaxRedemptionsPerAccount

public void setMaxRedemptionsPerAccount(Object maxRedemptionsPerAccount)

getType

public Coupon.Type getType()

setType

public void setType(Coupon.Type type)

getUniqueCodeTemplate

public String getUniqueCodeTemplate()

setUniqueCodeTemplate

public void setUniqueCodeTemplate(Object uniqueCodeTemplate)

getNumberOfUniqueCodes

public Integer getNumberOfUniqueCodes()

setNumberOfUniqueCodes

public void setNumberOfUniqueCodes(Integer numberOfUniqueCodes)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class RecurlyObject

hashCode

public int hashCode()

Overrides:

hashCode in class Object