com.konakartadmin.bl

Class AdminBillingMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminBillingMgr

All Implemented Interfaces:

AdminBillingMgrIf

public class AdminBillingMgr
extends AdminBaseMgr
implements AdminBillingMgrIf

The AdminBillingMgr - for Managing recurring billing

Nested Class Summary

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBaseMgr

AdminBaseMgr.StaticData

Field Summary

Fields

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

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminBillingMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addPaymentScheduleOrderBy(com.konakart.db.KKCriteria c, AdminPaymentScheduleSearch search) Add order by constraints for payment schedules
protected int	addPaymentScheduleSearchCriteria(com.konakart.db.KKCriteria c, AdminPaymentScheduleSearch search) Add search criteria for payment schedule objects
protected void	addSubscriptionOrderBy(com.konakart.db.KKCriteria c, AdminSubscriptionSearch search) Add order by constraints for subscriptions
protected void	addSubscriptionSearchCriteria(com.konakart.db.KKCriteria c, AdminSubscriptionSearch search) Add search criteria for subscription objects
int	deletePaymentSchedule(int id) Delete a Payment Schedule Object
int	deleteSubscription(int id) Delete a Subscription Object
AdminPaymentSchedule	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.
AdminPaymentSchedule	getPaymentSchedule(int id, java.sql.Connection con) Returns the payment schedule object for the id parameter, or Null if the payment schedule object doesn't exist in the DB.
protected int	getPaymentScheduleCount(AdminPaymentScheduleSearch search) Returns a count of the number of PaymentSchedules
AdminPaymentScheduleSearchResult	getPaymentSchedules(AdminPaymentScheduleSearch search, int offset, int size) This returns an AdminPaymentScheduleSearchResult object.
AdminSubscription	getSubscription(int id) Returns the subscription object for the id parameter, or Null if the subscription object doesn't exist in the DB.
protected int	getSubscriptionCount(AdminSubscriptionSearch search) Returns a count of the number of Subscriptions
AdminSubscriptionSearchResult	getSubscriptions(AdminSubscriptionSearch search, int offset, int size) This returns an AdminSubscriptionSearchResult object.
int	insertPaymentSchedule(AdminPaymentSchedule ps) An AdminPaymentSchedule object is inserted into the database.
int	insertSubscription(AdminSubscription subscription) An AdminSubscription object is inserted into the database.
protected void	setPaymentScheduleCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c, int customerId) Common code to avoid duplication
protected void	setSubscriptionCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c) Common code to avoid duplication
int	updatePaymentSchedule(AdminPaymentSchedule ps) Update an AdminPaymentSchedule object.
int	updateSubscription(AdminSubscription subscription) Update an AdminSubscription object.
protected void	validatePaymentSchedule(AdminPaymentSchedule ps) Common code used for inserting and for editing
protected void	validateSubscription(AdminSubscription subscription) Common code used for inserting and for editing

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, refreshConfigs, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, 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

AdminBillingMgr

public AdminBillingMgr(KKAdminIf eng)
                throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

deletePaymentSchedule

public int deletePaymentSchedule(int id)
                          throws KKAdminException,
                                 org.apache.torque.TorqueException

Delete a Payment Schedule Object

Specified by:

deletePaymentSchedule in interface AdminBillingMgrIf

Parameters:

id - The id of the payment schedule object to delete

Returns:

Returns the id of the deleted payment schedule object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

deleteSubscription

public int deleteSubscription(int id)
                       throws KKAdminException,
                              org.apache.torque.TorqueException

Delete a Subscription Object

Specified by:

deleteSubscription in interface AdminBillingMgrIf

Parameters:

id - The id of the subscription object to delete

Returns:

Returns the id of the deleted subscription object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getPaymentSchedule

public AdminPaymentSchedule getPaymentSchedule(int id)
                                        throws KKAdminException,
                                               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 AdminBillingMgrIf

Parameters:

id - The id of the payment schedule object

Returns:

Returns a payment schedule object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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 AdminPaymentSchedule getPaymentSchedule(int id,
                                               java.sql.Connection con)
                                        throws KKAdminException,
                                               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 AdminBillingMgrIf

Parameters:

id - The id of the payment schedule object

con - Connection for Transaction

Returns:

Returns a payment schedule object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

getSubscription

public AdminSubscription getSubscription(int id)
                                  throws KKAdminException,
                                         org.apache.torque.TorqueException,
                                         com.workingdogs.village.DataSetException

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

Specified by:

getSubscription in interface AdminBillingMgrIf

Parameters:

id - The id of the subscription object

Returns:

Returns a subscription object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

getPaymentScheduleCount

protected int getPaymentScheduleCount(AdminPaymentScheduleSearch search)
                               throws org.apache.torque.TorqueException,
                                      com.workingdogs.village.DataSetException,
                                      KKAdminException

Returns a count of the number of PaymentSchedules

Parameters:

search - Search criteria

Returns:

A count of the number of PaymentSchedule objects

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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getSubscriptionCount

protected int getSubscriptionCount(AdminSubscriptionSearch search)
                            throws org.apache.torque.TorqueException,
                                   com.workingdogs.village.DataSetException,
                                   KKAdminException

Returns a count of the number of Subscriptions

Parameters:

search - Search criteria

Returns:

A count of the number of Subscription objects

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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getPaymentSchedules

public AdminPaymentScheduleSearchResult getPaymentSchedules(AdminPaymentScheduleSearch search,
                                                            int offset,
                                                            int size)
                                                     throws org.apache.torque.TorqueException,
                                                            com.workingdogs.village.DataSetException,
                                                            KKAdminException

This returns an AdminPaymentScheduleSearchResult object.

Specified by:

getPaymentSchedules in interface AdminBillingMgrIf

Parameters:

search - The object containing the search constraints

offset - the offset in the db

size - the number of records from the specified offset

Returns:

Returns an AdminPaymentScheduleSearchResult object

Throws:

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

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

getSubscriptions

public AdminSubscriptionSearchResult getSubscriptions(AdminSubscriptionSearch search,
                                                      int offset,
                                                      int size)
                                               throws org.apache.torque.TorqueException,
                                                      com.workingdogs.village.DataSetException,
                                                      KKAdminException

This returns an AdminSubscriptionSearchResult object.

Specified by:

getSubscriptions in interface AdminBillingMgrIf

Parameters:

search - The object containing the search constraints

offset - the offset in the db

size - the number of records from the specified offset

Returns:

Returns an AdminSubscriptionSearchResult object

Throws:

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

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertPaymentSchedule

public int insertPaymentSchedule(AdminPaymentSchedule ps)
                          throws KKAdminException,
                                 org.apache.torque.TorqueException

An AdminPaymentSchedule object is inserted into the database. The following payment schedule attributes are compulsory:

• name
• timeUnit should be set to a valid time unit
• timeLength should be greater than zero

The id of the new object is returned.

Specified by:

insertPaymentSchedule in interface AdminBillingMgrIf

Parameters:

ps - the ps

Returns:

Returns the id of the PaymentSchedule object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

insertSubscription

public int insertSubscription(AdminSubscription subscription)
                       throws KKAdminException,
                              org.apache.torque.TorqueException

An AdminSubscription object is inserted into the database. The following subscription attributes are compulsory:

• A valid customerId
• A valid orderId
• A valid productId
• A valid paymentScheduleId
• Amount

The id of the new object is returned.

Specified by:

insertSubscription in interface AdminBillingMgrIf

Parameters:

subscription - the subscription

Returns:

Returns the id of the Subscription object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

updatePaymentSchedule

public int updatePaymentSchedule(AdminPaymentSchedule ps)
                          throws KKAdminException,
                                 org.apache.torque.TorqueException,
                                 com.workingdogs.village.DataSetException

Update an AdminPaymentSchedule object. If the value of an attribute is null, the current value is not updated.

Specified by:

updatePaymentSchedule in interface AdminBillingMgrIf

Parameters:

ps - An AdminPaymentSchedule object

Returns:

Returns the id of the updated AdminPaymentSchedule object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

updateSubscription

public int updateSubscription(AdminSubscription subscription)
                       throws KKAdminException,
                              org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException

Update an AdminSubscription object. If the value of an attribute is null, the current value is not updated.

Specified by:

updateSubscription in interface AdminBillingMgrIf

Parameters:

subscription - An AdminSubscription object

Returns:

Returns the id of the updated AdminSubscription object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

validatePaymentSchedule

protected void validatePaymentSchedule(AdminPaymentSchedule ps)
                                throws KKAdminException

Common code used for inserting and for editing

Parameters:

ps - the ps

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

validateSubscription

protected void validateSubscription(AdminSubscription subscription)
                             throws KKAdminException,
                                    org.apache.torque.TorqueException

Common code used for inserting and for editing

Parameters:

subscription - the subscription

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

setPaymentScheduleCriteriaWithStandardAttributes

protected void setPaymentScheduleCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c,
                                                                int customerId)

Common code to avoid duplication

Parameters:

c - the c

customerId - the customerId

setSubscriptionCriteriaWithStandardAttributes

protected void setSubscriptionCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c)

Common code to avoid duplication

Parameters:

c - the c

addPaymentScheduleSearchCriteria

protected int addPaymentScheduleSearchCriteria(com.konakart.db.KKCriteria c,
                                               AdminPaymentScheduleSearch search)

Add search criteria for payment schedule objects

Parameters:

c - the c

search - the search

Returns:

Returns the number of constraints added

addSubscriptionSearchCriteria

protected void addSubscriptionSearchCriteria(com.konakart.db.KKCriteria c,
                                             AdminSubscriptionSearch search)

Add search criteria for subscription objects

Parameters:

c - the c

search - the search

addPaymentScheduleOrderBy

protected void addPaymentScheduleOrderBy(com.konakart.db.KKCriteria c,
                                         AdminPaymentScheduleSearch search)

Add order by constraints for payment schedules

Parameters:

c - the c

search - the search

addSubscriptionOrderBy

protected void addSubscriptionOrderBy(com.konakart.db.KKCriteria c,
                                      AdminSubscriptionSearch search)

Add order by constraints for subscriptions

Parameters:

c - the c

search - the search