com.konakart.bl

Class BillingMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.BillingMgr

All Implemented Interfaces:

BillingMgrIf

public class BillingMgr
extends BaseMgr
implements BillingMgrIf

Manager for recurring billing

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
BillingMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected int	getCount(KKCriteria c) This method is mainly used for paging.
PaymentSchedule	getPaymentSchedule(int id) Returns the payment schedule object for the id parameter, or Null if the payment schedule object doesn't exist in the DB.
Subscription[]	getSubscriptionsPerCustomer(java.lang.String sessionId) Returns an array of Subscription objects for a customer referred to by the sessionId parameter.
int	insertSubscription(java.lang.String sessionId, SubscriptionIf subscription) A Subscription object is inserted into the database.
int	insertSubscription(SubscriptionIf subscription) A Subscription object is inserted into the database.
protected void	manageDataDescriptor(DataDescriptorIf dataDesc, KKCriteria c) Provides common code to deal with the management of the DataDescriptor.
Subscriptions	searchForSubscriptionsPerCustomer(java.lang.String sessionId, DataDescriptorIf dataDesc, SubscriptionSearchIf subscriptionSearch) Return subscriptions matching the search criteria.
protected void	setPaymentScheduleCriteriaWithStandardAttributes(KKCriteria c, int customerId) Set the attributes for reading a payment schedule object
protected void	setSubscriptionCriteriaWithStandardAttributes(KKCriteria c) Common code to avoid duplication
void	updateSubscription(java.lang.String sessionId, SubscriptionIf subscription) A Subscription object identified by the subscription passed in as a parameter is updated in the database.
void	updateSubscription(SubscriptionIf subscription) A Subscription object identified by the subscription passed in as a parameter is updated in the database.
protected void	updateSubscriptionPrivate(java.lang.String sessionId, SubscriptionIf subscription) A subscription object passed in as a parameter is updated
protected void	validateSubscription(SubscriptionIf subscription) Used to validate a subscription

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

Constructor Detail

BillingMgr

public BillingMgr(KKEngIf eng)
           throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

insertSubscription

public int insertSubscription(java.lang.String sessionId,
                              SubscriptionIf subscription)
                       throws java.lang.Exception

A Subscription object is inserted into the database. The following subscription attributes are compulsory:

• A valid orderId belonging to the customer referenced by the sessionId
• A valid productId
• A valid paymentScheduleId
• Amount

The customer id of the Subscription object is fetched from the sessionId. The id of the new object is returned.

The methods:

• beforeInsertSubscription()
• afterInsertSubscription

of the OrderIntegrationMgr are called before and after the insert to allow code to be inserted that calls a payment gateway.

Specified by:

insertSubscription in interface BillingMgrIf

Parameters:

sessionId - The session id of the logged in user

subscription - The subscription object to be inserted

Returns:

Returns the id of the Subscription object

Throws:

java.lang.Exception - an unexpected exception

insertSubscription

public int insertSubscription(SubscriptionIf subscription)
                       throws java.lang.Exception

A Subscription object is inserted into the database. The following subscription attributes are compulsory:

• A valid orderId belonging to the customer referenced by the sessionId
• A valid productId
• A valid paymentScheduleId
• Amount

The customer id of the Subscription object is fetched from the sessionId. The id of the new object is returned.

The methods:

• beforeInsertSubscription()
• afterInsertSubscription

of the OrderIntegrationMgr are called before and after the insert to allow code to be inserted that calls a payment gateway.

Specified by:

insertSubscription in interface BillingMgrIf

Parameters:

subscription - The subscription object to be inserted

Returns:

Returns the id of the Subscription object

Throws:

java.lang.Exception - an unexpected exception

updateSubscription

public void updateSubscription(java.lang.String sessionId,
                               SubscriptionIf subscription)
                        throws java.lang.Exception

A Subscription object identified by the subscription passed in as a parameter is updated in the database. A check is made to ensure that the subscription belongs to the customer identified by the sessionId. The methods:

• beforeUpdateSubscription()
• afterUpdateSubscription

of the OrderIntegrationMgr are called before and after the update to allow code to be inserted that calls a payment gateway.

Specified by:

updateSubscription in interface BillingMgrIf

Parameters:

sessionId - The session id of the logged in user

subscription - The subscription object to be updated

Throws:

java.lang.Exception - an unexpected exception

updateSubscription

public void updateSubscription(SubscriptionIf subscription)
                        throws java.lang.Exception

A Subscription object identified by the subscription passed in as a parameter is updated in the database. The methods:

• beforeUpdateSubscription()
• afterUpdateSubscription

of the OrderIntegrationMgr are called before and after the update to allow code to be inserted that calls a payment gateway.

Specified by:

updateSubscription in interface BillingMgrIf

Parameters:

subscription - The subscription object to be updated

Throws:

java.lang.Exception - an unexpected exception

updateSubscriptionPrivate

protected void updateSubscriptionPrivate(java.lang.String sessionId,
                                         SubscriptionIf subscription)
                                  throws java.lang.Exception

A subscription object passed in as a parameter is updated

Parameters:

sessionId - the sessionId

subscription - the subscription

Throws:

java.lang.Exception - an unexpected exception

validateSubscription

protected void validateSubscription(SubscriptionIf subscription)
                             throws com.konakart.app.KKException,
                                    org.apache.torque.TorqueException,
                                    com.workingdogs.village.DataSetException

Used to validate a subscription

Parameters:

subscription - the subscription

Throws:

com.konakart.app.KKException - an unexpected KKException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getPaymentSchedule

public PaymentSchedule getPaymentSchedule(int id)
                                   throws com.konakart.app.KKException,
                                          org.apache.torque.TorqueException,
                                          com.workingdogs.village.DataSetException

Returns the payment schedule object for the id parameter, or Null if the payment schedule object doesn't exist in the DB.

Specified by:

getPaymentSchedule in interface BillingMgrIf

Parameters:

id - The id of the payment schedule object

Returns:

Returns a payment schedule object

Throws:

com.konakart.app.KKException - an unexpected KKException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

setPaymentScheduleCriteriaWithStandardAttributes

protected void setPaymentScheduleCriteriaWithStandardAttributes(KKCriteria c,
                                                                int customerId)

Set the attributes for reading a payment schedule object

Parameters:

c - the c

customerId - the customerId

getSubscriptionsPerCustomer

public Subscription[] getSubscriptionsPerCustomer(java.lang.String sessionId)
                                           throws java.lang.Exception

Returns an array of Subscription objects for a customer referred to by the sessionId parameter.

Specified by:

getSubscriptionsPerCustomer in interface BillingMgrIf

Parameters:

sessionId - the sessionId

Returns:

Returns an array of subscription objects

Throws:

java.lang.Exception - an unexpected exception

setSubscriptionCriteriaWithStandardAttributes

protected void setSubscriptionCriteriaWithStandardAttributes(KKCriteria c)

Common code to avoid duplication

Parameters:

c - the c

searchForSubscriptionsPerCustomer

public Subscriptions searchForSubscriptionsPerCustomer(java.lang.String sessionId,
                                                       DataDescriptorIf dataDesc,
                                                       SubscriptionSearchIf subscriptionSearch)
                                                throws java.lang.Exception

Return subscriptions matching the search criteria.

Specified by:

searchForSubscriptionsPerCustomer in interface BillingMgrIf

Parameters:

sessionId - the sessionId

dataDesc - the dataDesc

subscriptionSearch - the subscriptionSearch

Returns:

A Subscriptions object

Throws:

java.lang.Exception - an unexpected exception

getCount

protected int getCount(KKCriteria c)
                throws org.apache.torque.TorqueException,
                       com.workingdogs.village.DataSetException

This method is mainly used for paging.

Parameters:

c - the c

Returns:

The number of records present in the database matching the given criteria

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

manageDataDescriptor

protected void manageDataDescriptor(DataDescriptorIf dataDesc,
                                    KKCriteria c)

Provides common code to deal with the management of the DataDescriptor.

Parameters:

dataDesc - the dataDesc

c - the c