AdminSubscription (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.app.AdminSubscription

public class AdminSubscription
extends java.lang.Object

Defines a recurring billing subscription.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`active` Set to true when the subscription is active
`private java.math.BigDecimal`	`amount` The amount billed
`private java.lang.String`	`custom1` custom field
`private java.lang.String`	`custom2` custom field
`private java.lang.String`	`custom3` custom field
`private java.lang.String`	`custom4` custom field
`private java.lang.String`	`custom5` custom field
`private int`	`customerId` Id of the customer
`private java.util.Date`	`dateAdded` dateAdded
`private int`	`id` Id
`private java.util.Date`	`lastBillingDate` The last time that the customer was billed
`private java.util.Date`	`lastModified` lastModified
`private java.util.Date`	`nextBillingDate` The next time that the customer will be billed
`private int`	`orderId` Id of the order
`private java.lang.String`	`orderNumber` The order number
`private AdminPaymentSchedule`	`paymentSchedule` The Payment Schedule object for the subscription
`private int`	`paymentScheduleId` The Payment Schedule id for the subscription
`private boolean`	`problem` Set to true if a problem has been detected during a billing transaction.
`private java.lang.String`	`problemDesc` A description of the problem detected during billing
`private int`	`productId` Id of the product being paid for
`private java.lang.String`	`productSku` SKU of the product being paid for
`private java.util.Date`	`startDate` Start date for the subscription
`private java.lang.String`	`subscriptionCode` Unique code for the subscription.
`private java.math.BigDecimal`	`trialAmount` The amount billed during the trial period

Constructor Summary

Constructors
Constructor and Description
`AdminSubscription()` Constructor
`AdminSubscription(com.workingdogs.village.Record vr, com.konakart.db.KKCriteria c)` Instantiates the attributes of the Country object from a Record object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.math.BigDecimal`	`getAmount()` The amount billed
`java.lang.String`	`getCustom1()`
`java.lang.String`	`getCustom2()`
`java.lang.String`	`getCustom3()`
`java.lang.String`	`getCustom4()`
`java.lang.String`	`getCustom5()`
`int`	`getCustomerId()` Customer id
`java.util.Date`	`getDateAdded()`
`int`	`getId()`
`java.util.Date`	`getLastBillingDate()` The last time that the customer was billed
`java.util.Date`	`getLastModified()`
`java.util.Date`	`getNextBillingDate()` The next time that the customer will be billed
`int`	`getOrderId()` Id of the order
`java.lang.String`	`getOrderNumber()` Order Number
`AdminPaymentSchedule`	`getPaymentSchedule()` PaymentSchedule object for this subscription
`int`	`getPaymentScheduleId()` PaymentSchedule id for this subscription
`java.lang.String`	`getProblemDesc()` A description of the problem detected during billing
`int`	`getProductId()` Id of the product being paid for
`java.lang.String`	`getProductSku()` SKU of the product being paid for
`java.util.Date`	`getStartDate()` Start date for the subscription
`java.lang.String`	`getSubscriptionCode()` Unique code for the subscription.
`java.math.BigDecimal`	`getTrialAmount()` The amount billed during the trial period
`boolean`	`isActive()` Set to true when the subscription is active
`boolean`	`isProblem()` Set to true if a problem has been detected during a billing transaction.
`void`	`setActive(boolean active)` Set to true when the subscription is active
`void`	`setAmount(java.math.BigDecimal amount)` The amount billed
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom2(java.lang.String custom2)`
`void`	`setCustom3(java.lang.String custom3)`
`void`	`setCustom4(java.lang.String custom4)`
`void`	`setCustom5(java.lang.String custom5)`
`void`	`setCustomerId(int customerId)` Customer id
`void`	`setDateAdded(java.util.Date dateAdded)`
`void`	`setId(int id)`
`void`	`setLastBillingDate(java.util.Date lastBillingDate)` The last time that the customer was billed
`void`	`setLastModified(java.util.Date lastModified)`
`void`	`setNextBillingDate(java.util.Date nextBillingDate)` The next time that the customer will be billed
`void`	`setOrderId(int orderId)` Id of the order
`void`	`setOrderNumber(java.lang.String orderNumber)` Order Number
`void`	`setPaymentSchedule(AdminPaymentSchedule paymentSchedule)` PaymentSchedule object for this subscription
`void`	`setPaymentScheduleId(int paymentScheduleId)` PaymentSchedule id for this subscription
`void`	`setProblem(boolean problem)` Set to true if a problem has been detected during a billing transaction.
`void`	`setProblemDesc(java.lang.String problemDesc)` A description of the problem detected during billing
`void`	`setProductId(int productId)` Id of the product being paid for
`void`	`setProductSku(java.lang.String productSku)` SKU of the product being paid for
`void`	`setStartDate(java.util.Date startDate)` Start date for the subscription
`void`	`setSubscriptionCode(java.lang.String subscriptionCode)` Unique code for the subscription.
`void`	`setTrialAmount(java.math.BigDecimal trialAmount)` The amount billed during the trial period
`java.lang.String`	`toString()`

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

- Field Detail
  - id
```
private int id
```
    Id
  - orderId
```
private int orderId
```
    Id of the order
  - orderNumber
```
private java.lang.String orderNumber
```
    The order number
  - productId
```
private int productId
```
    Id of the product being paid for
  - customerId
```
private int customerId
```
    Id of the customer
  - productSku
```
private java.lang.String productSku
```
    SKU of the product being paid for
  - subscriptionCode
```
private java.lang.String subscriptionCode
```
    Unique code for the subscription. Normally returned by a payment gateway when the subscription is created.
  - startDate
```
private java.util.Date startDate
```
    Start date for the subscription
  - amount
```
private java.math.BigDecimal amount
```
    The amount billed
  - trialAmount
```
private java.math.BigDecimal trialAmount
```
    The amount billed during the trial period
  - active
```
private boolean active
```
    Set to true when the subscription is active
  - problem
```
private boolean problem
```
    Set to true if a problem has been detected during a billing transaction. i.e. Credit card may have expired.
  - problemDesc
```
private java.lang.String problemDesc
```
    A description of the problem detected during billing
  - lastBillingDate
```
private java.util.Date lastBillingDate
```
    The last time that the customer was billed
  - nextBillingDate
```
private java.util.Date nextBillingDate
```
    The next time that the customer will be billed
  - paymentSchedule
```
private AdminPaymentSchedule paymentSchedule
```
    The Payment Schedule object for the subscription
  - paymentScheduleId
```
private int paymentScheduleId
```
    The Payment Schedule id for the subscription
  - custom1
```
private java.lang.String custom1
```
    custom field
  - custom2
```
private java.lang.String custom2
```
    custom field
  - custom3
```
private java.lang.String custom3
```
    custom field
  - custom4
```
private java.lang.String custom4
```
    custom field
  - custom5
```
private java.lang.String custom5
```
    custom field
  - dateAdded
```
private java.util.Date dateAdded
```
    dateAdded
  - lastModified
```
private java.util.Date lastModified
```
    lastModified
- Constructor Detail
  - AdminSubscription
```
public AdminSubscription()
```
    Constructor
  - AdminSubscription
```
public AdminSubscription(com.workingdogs.village.Record vr,
                         com.konakart.db.KKCriteria c)
                  throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the Country object from a Record object
    
    Parameters:
    
    vr - Record containing data
    
    c - Criteria containing column names
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the Subscription object.
  - getId
```
public int getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - the id to set
  - getCustom1
```
public java.lang.String getCustom1()
```
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
public java.lang.String getCustom2()
```
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom3
```
public java.lang.String getCustom3()
```
    Returns:
    
    the custom3
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom4
```
public java.lang.String getCustom4()
```
    Returns:
    
    the custom4
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - the custom4 to set
  - getCustom5
```
public java.lang.String getCustom5()
```
    Returns:
    
    the custom5
  - setCustom5
```
public void setCustom5(java.lang.String custom5)
```
    Parameters:
    
    custom5 - the custom5 to set
  - getDateAdded
```
public java.util.Date getDateAdded()
```
    Returns:
    
    the dateAdded
  - setDateAdded
```
public void setDateAdded(java.util.Date dateAdded)
```
    Parameters:
    
    dateAdded - the dateAdded to set
  - getLastModified
```
public java.util.Date getLastModified()
```
    Returns:
    
    the lastModified
  - setLastModified
```
public void setLastModified(java.util.Date lastModified)
```
    Parameters:
    
    lastModified - the lastModified to set
  - getOrderId
```
public int getOrderId()
```
    Id of the order
    
    Returns:
    
    the orderId
  - setOrderId
```
public void setOrderId(int orderId)
```
    Id of the order
    
    Parameters:
    
    orderId - the orderId to set
  - getProductId
```
public int getProductId()
```
    Id of the product being paid for
    
    Returns:
    
    the productId
  - setProductId
```
public void setProductId(int productId)
```
    Id of the product being paid for
    
    Parameters:
    
    productId - the productId to set
  - getSubscriptionCode
```
public java.lang.String getSubscriptionCode()
```
    Unique code for the subscription. Normally returned by a payment gateway when the subscription is created.
    
    Returns:
    
    the subscriptionCode
  - setSubscriptionCode
```
public void setSubscriptionCode(java.lang.String subscriptionCode)
```
    Unique code for the subscription. Normally returned by a payment gateway when the subscription is created.
    
    Parameters:
    
    subscriptionCode - the subscriptionCode to set
  - getStartDate
```
public java.util.Date getStartDate()
```
    Start date for the subscription
    
    Returns:
    
    the startDate
  - setStartDate
```
public void setStartDate(java.util.Date startDate)
```
    Start date for the subscription
    
    Parameters:
    
    startDate - the startDate to set
  - getAmount
```
public java.math.BigDecimal getAmount()
```
    The amount billed
    
    Returns:
    
    the amount
  - setAmount
```
public void setAmount(java.math.BigDecimal amount)
```
    The amount billed
    
    Parameters:
    
    amount - the amount to set
  - getTrialAmount
```
public java.math.BigDecimal getTrialAmount()
```
    The amount billed during the trial period
    
    Returns:
    
    the trialAmount
  - setTrialAmount
```
public void setTrialAmount(java.math.BigDecimal trialAmount)
```
    The amount billed during the trial period
    
    Parameters:
    
    trialAmount - the trialAmount to set
  - isActive
```
public boolean isActive()
```
    Set to true when the subscription is active
    
    Returns:
    
    the active
  - setActive
```
public void setActive(boolean active)
```
    Set to true when the subscription is active
    
    Parameters:
    
    active - the active to set
  - isProblem
```
public boolean isProblem()
```
    Set to true if a problem has been detected during a billing transaction. i.e. Credit card may have expired.
    
    Returns:
    
    the problem
  - setProblem
```
public void setProblem(boolean problem)
```
    Set to true if a problem has been detected during a billing transaction. i.e. Credit card may have expired.
    
    Parameters:
    
    problem - the problem to set
  - getProblemDesc
```
public java.lang.String getProblemDesc()
```
    A description of the problem detected during billing
    
    Returns:
    
    the problemDesc
  - setProblemDesc
```
public void setProblemDesc(java.lang.String problemDesc)
```
    A description of the problem detected during billing
    
    Parameters:
    
    problemDesc - the problemDesc to set
  - getLastBillingDate
```
public java.util.Date getLastBillingDate()
```
    The last time that the customer was billed
    
    Returns:
    
    the lastBillingDate
  - setLastBillingDate
```
public void setLastBillingDate(java.util.Date lastBillingDate)
```
    The last time that the customer was billed
    
    Parameters:
    
    lastBillingDate - the lastBillingDate to set
  - getNextBillingDate
```
public java.util.Date getNextBillingDate()
```
    The next time that the customer will be billed
    
    Returns:
    
    the nextBillingDate
  - setNextBillingDate
```
public void setNextBillingDate(java.util.Date nextBillingDate)
```
    The next time that the customer will be billed
    
    Parameters:
    
    nextBillingDate - the nextBillingDate to set
  - getPaymentSchedule
```
public AdminPaymentSchedule getPaymentSchedule()
```
    PaymentSchedule object for this subscription
    
    Returns:
    
    the paymentSchedule
  - setPaymentSchedule
```
public void setPaymentSchedule(AdminPaymentSchedule paymentSchedule)
```
    PaymentSchedule object for this subscription
    
    Parameters:
    
    paymentSchedule - the paymentSchedule to set
  - getPaymentScheduleId
```
public int getPaymentScheduleId()
```
    PaymentSchedule id for this subscription
    
    Returns:
    
    the paymentScheduleId
  - setPaymentScheduleId
```
public void setPaymentScheduleId(int paymentScheduleId)
```
    PaymentSchedule id for this subscription
    
    Parameters:
    
    paymentScheduleId - the paymentScheduleId to set
  - getOrderNumber
```
public java.lang.String getOrderNumber()
```
    Order Number
    
    Returns:
    
    the orderNumber
  - setOrderNumber
```
public void setOrderNumber(java.lang.String orderNumber)
```
    Order Number
    
    Parameters:
    
    orderNumber - the orderNumber to set
  - getProductSku
```
public java.lang.String getProductSku()
```
    SKU of the product being paid for
    
    Returns:
    
    the productSku
  - setProductSku
```
public void setProductSku(java.lang.String productSku)
```
    SKU of the product being paid for
    
    Parameters:
    
    productSku - the productSku to set
  - getCustomerId
```
public int getCustomerId()
```
    Customer id
    
    Returns:
    
    the customerId
  - setCustomerId
```
public void setCustomerId(int customerId)
```
    Customer id
    
    Parameters:
    
    customerId - the customerId to set

Class AdminSubscription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

orderId

orderNumber

productId

customerId

productSku

subscriptionCode

startDate

amount

trialAmount

active

problem

problemDesc

lastBillingDate

nextBillingDate

paymentSchedule

paymentScheduleId

custom1

custom2

custom3

custom4

custom5

dateAdded

lastModified

Constructor Detail

AdminSubscription

AdminSubscription

Method Detail

toString

getId

setId

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

getDateAdded

setDateAdded

getLastModified

setLastModified

getOrderId

setOrderId

getProductId

setProductId

getSubscriptionCode

setSubscriptionCode

getStartDate

setStartDate

getAmount

setAmount

getTrialAmount

setTrialAmount

isActive

setActive

isProblem

setProblem

getProblemDesc

setProblemDesc

getLastBillingDate

setLastBillingDate

getNextBillingDate

setNextBillingDate

getPaymentSchedule

setPaymentSchedule

getPaymentScheduleId

setPaymentScheduleId

getOrderNumber

setOrderNumber

getProductSku