Coupon (billforward-java 1.2015.155 API)

java.lang.Object
- net.billforward.model.BillingEntity
- - net.billforward.model.InsertableEntity<Coupon>
  - - net.billforward.model.Coupon

public class Coupon
extends InsertableEntity<Coupon>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Coupon.CouponTarget

Nested Classes
Modifier and Type	Class and Description
`static class`	`Coupon.CouponTarget`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Coupon.CouponTarget`	`appliesTo`
`protected String`	`appliesToID`
`protected String`	`couponCode`
`protected Integer`	`coupons`
`protected String`	`currency`
`protected boolean`	`deleted`
`protected List<CouponDiscount>`	`discounts`
`protected String`	`name`
`protected String`	`parentCouponCode`
`protected boolean`	`parentCouponCodeRedeemable`
`protected String`	`product`
`protected String`	`productID`
`protected String`	`productName`
`protected String`	`productRatePlan`
`protected String`	`productRatePlanID`
`protected String`	`productRatePlanName`
`protected int`	`quantity`
`protected Integer`	`remainingUses`
`protected static ResourcePath`	`resourcePath`
`protected Integer`	`used`
`protected Integer`	`uses`
`protected Date`	`validUntil`

Fields inherited from class net.billforward.model.BillingEntity
m_client, PRETTY_PRINT_GSON

Constructor Summary

Constructors
Constructor and Description

Coupon()

Coupon(BillForwardClient client_)

Coupon(String productRateID_)

Coupon(String product_, String productRatePlan_)

Constructors
Constructor and Description
`Coupon()`
`Coupon(BillForwardClient client_)`
`Coupon(String productRateID_)`
`Coupon(String product_, String productRatePlan_)`

Method Summary

Methods
Modifier and Type	Method and Description
`Coupon`	`addCashDiscount(int discountAmount)`
`Coupon`	`addCashDiscount(String pricingComponent, int discountAmount)`
`static Coupon`	`addCouponCodeToSubscription(String couponCode, String subscriptionID)`
`Coupon`	`addDiscount(CouponDiscount discount)`
`Coupon`	`addPercentageDiscount(int percentOff)`
`Coupon`	`addPercentageDiscount(String pricingComponent, int percentOff)`
`Coupon`	`addToSubscription(String subscriptionID)`
`Coupon`	`addUnitsFree(String pricingComponent, int unitsFree)`
`static Coupon`	`create(Coupon coupon)`
`static Coupon[]`	`createCouponCodes(String couponCode, int quantity)`
`Coupon[]`	`createUniqueCodes(int quantity)`
`static Coupon[]`	`getAll()`
`Coupon.CouponTarget`	`getAppliesTo()`
`String`	`getAppliesToID()`
`static Coupon`	`getByCode(String code)`
`String`	`getCouponCode()`
`Coupon[]`	`getCouponCodes()`
`static Coupon[]`	`getCouponCodes(String couponCode)`
`int`	`getCoupons()`
`static Coupon[]`	`getCouponsForSubscription(String subscriptionID)`
`Currency`	`getCurrency()`
`String`	`getCurrencyAsString()`
`List<CouponDiscount>`	`getDiscounts()`
`String`	`getName()`
`String`	`getParentCouponCode()`
`String`	`getProductID()`
`String`	`getProductName()`
`String`	`getProductRatePlan()`
`String`	`getProductRatePlanID()`
`String`	`getProductRatePlanName()`
`Integer`	`getRemainingUses()`
`protected ResourcePath`	`getResourcePath()`
`Integer`	`getUsed()`
`int`	`getUses()`
`Date`	`getValidUntil()`
`boolean`	`isParentCouponCodeRedeemable()`
`static Coupon`	`removeCouponCode(String couponCode)`
`Coupon`	`removeDiscount(CouponDiscount discount)`
`protected static ResourcePath`	`ResourcePath()`
`Coupon`	`setCouponCode(String couponCode)`
`Coupon`	`setCoupons(int coupons)`
`Coupon`	`setCurrency(Currency currency)`
`Coupon`	`setCurrency(String currency)`
`void`	`setName(String name)`
`Coupon`	`setParentCouponCodeRedeemable(boolean parentCouponCodeRedeemable)`
`void`	`setProductID(String productID)`
`void`	`setProductName(String productName)`
`void`	`setProductRatePlan(String productRatePlan)`
`void`	`setProductRatePlanID(String productRatePlanID)`
`void`	`setProductRatePlanName(String productRatePlanName)`
`Coupon`	`setUses(int uses)`

Methods inherited from class net.billforward.model.InsertableEntity
create, create, createExplicitPath, retire, retire, retire, retireExplicitPath

Methods inherited from class net.billforward.model.BillingEntity
getAll, getAll, getByID, getByID, getByID, getByID, getByIDPostPath, getClient, setClient, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name
```
protected String name
```

couponCode
```
protected String couponCode
```

coupons
```
protected Integer coupons
```

uses
```
protected Integer uses
```

product
```
protected String product
```

productRatePlan
```
protected String productRatePlan
```

currency
```
protected String currency
```

parentCouponCodeRedeemable

protected boolean parentCouponCodeRedeemable

productRatePlanName
```
protected String productRatePlanName
```

productRatePlanID
```
protected String productRatePlanID
```

productID
```
protected String productID
```

productName
```
protected String productName
```

deleted
```
protected boolean deleted
```

discounts

protected List<CouponDiscount> discounts

parentCouponCode
```
protected String parentCouponCode
```

appliesTo

protected Coupon.CouponTarget appliesTo

appliesToID
```
protected String appliesToID
```

remainingUses
```
protected Integer remainingUses
```

used
```
protected Integer used
```

validUntil
```
protected Date validUntil
```

quantity
```
protected int quantity
```

resourcePath

protected static ResourcePath resourcePath

Constructor Detail

Coupon

public Coupon(BillForwardClient client_)

Coupon
```
public Coupon()
```

Coupon
```
public Coupon(String productRateID_)
```

Coupon

public Coupon(String product_,
      String productRatePlan_)

Method Detail

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getCouponCode
```
public String getCouponCode()
```

setCouponCode

public Coupon setCouponCode(String couponCode)

getCoupons
```
public int getCoupons()
```

setCoupons

public Coupon setCoupons(int coupons)

getUses
```
public int getUses()
```

setUses
```
public Coupon setUses(int uses)
```

getCurrencyAsString
```
public String getCurrencyAsString()
```

getCurrency
```
public Currency getCurrency()
```

setCurrency

public Coupon setCurrency(Currency currency)

isParentCouponCodeRedeemable

public boolean isParentCouponCodeRedeemable()

setParentCouponCodeRedeemable

public Coupon setParentCouponCodeRedeemable(boolean parentCouponCodeRedeemable)

getProductRatePlan
```
public String getProductRatePlan()
```

setProductRatePlan

public void setProductRatePlan(String productRatePlan)

getProductRatePlanName

public String getProductRatePlanName()

setProductRatePlanName

public void setProductRatePlanName(String productRatePlanName)

getProductRatePlanID
```
public String getProductRatePlanID()
```

setProductRatePlanID

public void setProductRatePlanID(String productRatePlanID)

getProductID
```
public String getProductID()
```

setProductID

public void setProductID(String productID)

getProductName
```
public String getProductName()
```

setProductName

public void setProductName(String productName)

getParentCouponCode
```
public String getParentCouponCode()
```

getAppliesTo

public Coupon.CouponTarget getAppliesTo()

getAppliesToID
```
public String getAppliesToID()
```

getRemainingUses
```
public Integer getRemainingUses()
```

getUsed
```
public Integer getUsed()
```

setCurrency

public Coupon setCurrency(String currency)

getValidUntil
```
public Date getValidUntil()
```

getDiscounts

public List<CouponDiscount> getDiscounts()

addDiscount

public Coupon addDiscount(CouponDiscount discount)

removeDiscount

public Coupon removeDiscount(CouponDiscount discount)

create

public static Coupon create(Coupon coupon)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getByCode

public static Coupon getByCode(String code)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getAll

public static Coupon[] getAll()
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getResourcePath
```
protected ResourcePath getResourcePath()
```
Specified by:

getResourcePath in class BillingEntity

ResourcePath

protected static ResourcePath ResourcePath()

createUniqueCodes

public Coupon[] createUniqueCodes(int quantity)
                           throws AuthenticationException,
                                  InvalidRequestException,
                                  APIConnectionException,
                                  CardException,
                                  APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

createCouponCodes

public static Coupon[] createCouponCodes(String couponCode,
                         int quantity)
                                  throws AuthenticationException,
                                         InvalidRequestException,
                                         APIConnectionException,
                                         CardException,
                                         APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getCouponCodes

public Coupon[] getCouponCodes()
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getCouponCodes

public static Coupon[] getCouponCodes(String couponCode)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

addUnitsFree

public Coupon addUnitsFree(String pricingComponent,
                  int unitsFree)

addPercentageDiscount

public Coupon addPercentageDiscount(String pricingComponent,
                           int percentOff)

addPercentageDiscount

public Coupon addPercentageDiscount(int percentOff)

addCashDiscount

public Coupon addCashDiscount(String pricingComponent,
                     int discountAmount)

addCashDiscount

public Coupon addCashDiscount(int discountAmount)

addToSubscription

public Coupon addToSubscription(String subscriptionID)
                         throws AuthenticationException,
                                InvalidRequestException,
                                APIConnectionException,
                                CardException,
                                APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

addCouponCodeToSubscription

public static Coupon addCouponCodeToSubscription(String couponCode,
                                 String subscriptionID)
                                          throws AuthenticationException,
                                                 InvalidRequestException,
                                                 APIConnectionException,
                                                 CardException,
                                                 APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getCouponsForSubscription

public static Coupon[] getCouponsForSubscription(String subscriptionID)
                                          throws AuthenticationException,
                                                 InvalidRequestException,
                                                 APIConnectionException,
                                                 CardException,
                                                 APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

removeCouponCode

public static Coupon removeCouponCode(String couponCode)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

Class Coupon

Nested Class Summary

Field Summary

Fields inherited from class net.billforward.model.BillingEntity

Constructor Summary

Method Summary

Methods inherited from class net.billforward.model.InsertableEntity

Methods inherited from class net.billforward.model.BillingEntity

Methods inherited from class java.lang.Object

Field Detail

name

couponCode

coupons

uses

product

productRatePlan

currency

parentCouponCodeRedeemable

productRatePlanName

productRatePlanID

productID

productName

deleted

discounts

parentCouponCode

appliesTo

appliesToID

remainingUses

used

validUntil

quantity

resourcePath

Constructor Detail

Coupon

Coupon

Coupon

Coupon

Method Detail

getName

setName

getCouponCode

setCouponCode

getCoupons

setCoupons

getUses

setUses

getCurrencyAsString

getCurrency

setCurrency

isParentCouponCodeRedeemable

setParentCouponCodeRedeemable

getProductRatePlan

setProductRatePlan

getProductRatePlanName

setProductRatePlanName

getProductRatePlanID

setProductRatePlanID

getProductID

setProductID

getProductName

setProductName

getParentCouponCode

getAppliesTo

getAppliesToID

getRemainingUses

getUsed

setCurrency

getValidUntil

getDiscounts

addDiscount

removeDiscount

create

getByCode

getAll

getResourcePath

ResourcePath

createUniqueCodes

createCouponCodes

getCouponCodes

getCouponCodes