com.konakart.appif

Interface SubscriptionIf

All Known Implementing Classes:

Subscription

public interface SubscriptionIf

Defines a recurring billing subscription.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount() The amount billed
CreditCardIf	getCreditCard() Credit Card for the subscription
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.Calendar	getDateAdded()
int	getId()
java.util.Calendar	getLastBillingDate() The last time that the customer was billed
java.util.Calendar	getLastModified()
java.util.Calendar	getNextBillingDate() The next time that the customer will be billed
int	getOrderId() Id of the order
java.lang.String	getOrderNumber() Order Number
PaymentScheduleIf	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.Calendar	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	setCreditCard(CreditCardIf creditCard) Credit Card for the subscription
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.Calendar dateAdded)
void	setId(int id)
void	setLastBillingDate(java.util.Calendar lastBillingDate) The last time that the customer was billed
void	setLastModified(java.util.Calendar lastModified)
void	setNextBillingDate(java.util.Calendar 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(PaymentScheduleIf 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.Calendar 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

Method Detail

getId

int getId()

Returns:

the id

setId

void setId(int id)

Parameters:

id - the id to set

getCustom1

java.lang.String getCustom1()

Returns:

the custom1

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - the custom1 to set

getCustom2

java.lang.String getCustom2()

Returns:

the custom2

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - the custom2 to set

getCustom3

java.lang.String getCustom3()

Returns:

the custom3

setCustom3

void setCustom3(java.lang.String custom3)

Parameters:

custom3 - the custom3 to set

getCustom4

java.lang.String getCustom4()

Returns:

the custom4

setCustom4

void setCustom4(java.lang.String custom4)

Parameters:

custom4 - the custom4 to set

getCustom5

java.lang.String getCustom5()

Returns:

the custom5

setCustom5

void setCustom5(java.lang.String custom5)

Parameters:

custom5 - the custom5 to set

getDateAdded

java.util.Calendar getDateAdded()

Returns:

the dateAdded

setDateAdded

void setDateAdded(java.util.Calendar dateAdded)

Parameters:

dateAdded - the dateAdded to set

getLastModified

java.util.Calendar getLastModified()

Returns:

the lastModified

setLastModified

void setLastModified(java.util.Calendar lastModified)

Parameters:

lastModified - the lastModified to set

getOrderId

int getOrderId()

Id of the order

Returns:

the orderId

setOrderId

void setOrderId(int orderId)

Id of the order

Parameters:

orderId - the orderId to set

getProductId

int getProductId()

Id of the product being paid for

Returns:

the productId

setProductId

void setProductId(int productId)

Id of the product being paid for

Parameters:

productId - the productId to set

getSubscriptionCode

java.lang.String getSubscriptionCode()

Unique code for the subscription. Normally returned by a payment gateway when the subscription is created.

Returns:

the subscriptionCode

setSubscriptionCode

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

java.util.Calendar getStartDate()

Start date for the subscription

Returns:

the startDate

setStartDate

void setStartDate(java.util.Calendar startDate)

Start date for the subscription

Parameters:

startDate - the startDate to set

getAmount

java.math.BigDecimal getAmount()

The amount billed

Returns:

the amount

setAmount

void setAmount(java.math.BigDecimal amount)

The amount billed

Parameters:

amount - the amount to set

getTrialAmount

java.math.BigDecimal getTrialAmount()

The amount billed during the trial period

Returns:

the trialAmount

setTrialAmount

void setTrialAmount(java.math.BigDecimal trialAmount)

The amount billed during the trial period

Parameters:

trialAmount - the trialAmount to set

isActive

boolean isActive()

Set to true when the subscription is active

Returns:

the active

setActive

void setActive(boolean active)

Set to true when the subscription is active

Parameters:

active - the active to set

isProblem

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

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

java.lang.String getProblemDesc()

A description of the problem detected during billing

Returns:

the problemDesc

setProblemDesc

void setProblemDesc(java.lang.String problemDesc)

A description of the problem detected during billing

Parameters:

problemDesc - the problemDesc to set

getLastBillingDate

java.util.Calendar getLastBillingDate()

The last time that the customer was billed

Returns:

the lastBillingDate

setLastBillingDate

void setLastBillingDate(java.util.Calendar lastBillingDate)

The last time that the customer was billed

Parameters:

lastBillingDate - the lastBillingDate to set

getNextBillingDate

java.util.Calendar getNextBillingDate()

The next time that the customer will be billed

Returns:

the nextBillingDate

setNextBillingDate

void setNextBillingDate(java.util.Calendar nextBillingDate)

The next time that the customer will be billed

Parameters:

nextBillingDate - the nextBillingDate to set

getPaymentSchedule

PaymentScheduleIf getPaymentSchedule()

PaymentSchedule object for this subscription

Returns:

the paymentSchedule

setPaymentSchedule

void setPaymentSchedule(PaymentScheduleIf paymentSchedule)

PaymentSchedule object for this subscription

Parameters:

paymentSchedule - the paymentSchedule to set

getPaymentScheduleId

int getPaymentScheduleId()

PaymentSchedule id for this subscription

Returns:

the paymentScheduleId

setPaymentScheduleId

void setPaymentScheduleId(int paymentScheduleId)

PaymentSchedule id for this subscription

Parameters:

paymentScheduleId - the paymentScheduleId to set

getOrderNumber

java.lang.String getOrderNumber()

Order Number

Returns:

the orderNumber

setOrderNumber

void setOrderNumber(java.lang.String orderNumber)

Order Number

Parameters:

orderNumber - the orderNumber to set

getProductSku

java.lang.String getProductSku()

SKU of the product being paid for

Returns:

the productSku

setProductSku

void setProductSku(java.lang.String productSku)

SKU of the product being paid for

Parameters:

productSku - the productSku to set

getCustomerId

int getCustomerId()

Customer id

Returns:

the customerId

setCustomerId

void setCustomerId(int customerId)

Customer id

Parameters:

customerId - the customerId to set

getCreditCard

CreditCardIf getCreditCard()

Credit Card for the subscription

Returns:

the creditCard

setCreditCard

void setCreditCard(CreditCardIf creditCard)

Credit Card for the subscription

Parameters:

creditCard - the creditCard to set