com.konakartadmin.bl

Class AdminBookableProductMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminBookableProductMgr

All Implemented Interfaces:

AdminBookableProductMgrIf

public class AdminBookableProductMgr
extends AdminBaseMgr
implements AdminBookableProductMgrIf

The AdminBookableProductMgr - for Managing bookable products

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 int	BOOKING_COUNT_RETRIES_DEFAULT Default for number of retries when updating booking count
protected static int	bookingCountMaxRetries Number of times to retry the booking count update SQL
protected static java.lang.String	bookingCountMutex Mutex for updating booking count
protected static java.lang.String	bookProdMgrMutex Mutex for the bookable product manager
private static boolean	configInit Flag to determine whether the configs have been initialised
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
AdminBookableProductMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addBookingOrderBy(com.konakart.db.KKCriteria c, AdminBookingSearch search) Add the order by constraints
protected int	addBookingSearchCriteria(com.konakart.db.KKCriteria c, AdminBookingSearch search, AdminBookableProductOptions options) Add the search criteria
void	deleteBookableProduct(int productId) Delete the bookable Product
void	deleteBookableProduct(int productId, java.sql.Connection con) Delete the bookable Product
void	deleteBooking(int bookingId, AdminBookableProductOptions options) Delete the booking
AdminBookableProduct	getBookableProduct(int productId) Gets a Bookable Product object for a product id
AdminBookableProduct	getBookableProduct(int productId, java.sql.Connection con) Gets a Bookable Product object for a product id
AdminBooking	getBooking(int bookingId, AdminBookableProductOptions options) Return a booking by Id
protected int	getBookingCount(AdminBookingSearch search, AdminBookableProductOptions options) Get the number of bookings
static int	getBookingCountMaxRetries()
int	getBookingQty(int bookingId, AdminBookableProductOptions options) Return a booking by Id
AdminBookingSearchResult	getBookings(AdminBookingSearch search, int offset, int size, AdminBookableProductOptions bookableProductOptions) Method used to search for bookings.
private AdminConfigurationMgrIf	getCfgMgr()
void	insertBookableProduct(AdminBookableProduct bProd) Inserts a BookableProduct object into the database.
void	insertBookableProduct(AdminBookableProduct bProd, java.sql.Connection con, com.konakart.db.KKCriteria insertC) Inserts a BookableProduct object into the database.
int	insertBooking(AdminBooking booking, AdminBookableProductOptions options) Inserts a Booking object into the database.
void	refreshConfigs() Refresh the configuration of the bookable product manager
protected void	setBookableProductCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c) Set the standard attributes
static void	setBookingCountMaxRetries(int bookingCountMaxRetries)
protected void	setBookingCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c) Set the standard attributes
protected void	setBookingInsertCriteriaWithStandardAttributes(AdminBookableProduct bProd, com.konakart.db.KKCriteria insertC) Method that avoids duplication of code
protected void	setBookingUpdateCriteriaWithStandardAttributes(AdminBookableProduct bProd, com.konakart.db.KKCriteria selectC, com.konakart.db.KKCriteria updateC) Method that avoids duplication of code
void	updateBookableProduct(AdminBookableProduct bProd) This method is use to edit an existing bookable product.
void	updateBookableProduct(AdminBookableProduct bProd, java.sql.Connection con, com.konakart.db.KKCriteria selectC, com.konakart.db.KKCriteria updateC) This method is use to edit an existing bookable product.
void	updateBooking(AdminBooking booking, AdminBookableProductOptions options) This method is used to edit an existing booking.
protected void	updateBookingCount(int productId, AdminBookableProductOptions options, int numBookings) Update the number of bookings present
protected void	validateBookableProduct(AdminBookableProduct bProd, boolean checkProd) Validate the bookable product
protected void	validateBooking(AdminBooking booking, int bookingQtyChange, AdminBookableProductOptions options) Validate the booking

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, 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

bookingCountMutex

protected static java.lang.String bookingCountMutex

Mutex for updating booking count

BOOKING_COUNT_RETRIES_DEFAULT

protected static final int BOOKING_COUNT_RETRIES_DEFAULT

Default for number of retries when updating booking count

See Also:

Constant Field Values

bookingCountMaxRetries

protected static int bookingCountMaxRetries

Number of times to retry the booking count update SQL

bookProdMgrMutex

protected static java.lang.String bookProdMgrMutex

Mutex for the bookable product manager

configInit

private static boolean configInit

Flag to determine whether the configs have been initialised

Constructor Detail

AdminBookableProductMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

insertBookableProduct

public void insertBookableProduct(AdminBookableProduct bProd)
                           throws java.lang.Exception

Inserts a BookableProduct object into the database. The object must have a start date and end date and it must be associated with an existing product through the product id attribute.

Specified by:

insertBookableProduct in interface AdminBookableProductMgrIf

Parameters:

bProd - A bookable product object

Throws:

java.lang.Exception - an unexpected exception

insertBookableProduct

public void insertBookableProduct(AdminBookableProduct bProd,
                                  java.sql.Connection con,
                                  com.konakart.db.KKCriteria insertC)
                           throws java.lang.Exception

Inserts a BookableProduct object into the database. The object must have a start date and end date and it must be associated with an existing product through the product id attribute. Parameters are passed so that it may be used within a transaction.

Specified by:

insertBookableProduct in interface AdminBookableProductMgrIf

Parameters:

bProd - A bookable product object

con - Database connection

insertC - Criteria object

Throws:

java.lang.Exception - an unexpected exception

setBookingInsertCriteriaWithStandardAttributes

protected void setBookingInsertCriteriaWithStandardAttributes(AdminBookableProduct bProd,
                                                              com.konakart.db.KKCriteria insertC)

Method that avoids duplication of code

Parameters:

bProd - the bProd

insertC - the insertC

updateBookableProduct

public void updateBookableProduct(AdminBookableProduct bProd)
                           throws java.lang.Exception

This method is use to edit an existing bookable product. Attributes will null values will not be modified. The productId attribute of the bookable product must refer to an existing product. If the BookableProduct object doesn't exist, it is inserted.

Specified by:

updateBookableProduct in interface AdminBookableProductMgrIf

Parameters:

bProd - A bookable product object

Throws:

java.lang.Exception - an unexpected exception

updateBookableProduct

public void updateBookableProduct(AdminBookableProduct bProd,
                                  java.sql.Connection con,
                                  com.konakart.db.KKCriteria selectC,
                                  com.konakart.db.KKCriteria updateC)
                           throws java.lang.Exception

This method is use to edit an existing bookable product. Attributes will null values will not be modified. The productId attribute of the bookable product must refer to an existing product. If the BookableProduct object doesn't exist, it is inserted. Parameters are passed so that it may be used within a transaction.

Specified by:

updateBookableProduct in interface AdminBookableProductMgrIf

Parameters:

bProd - A bookable product object

con - Database connection

selectC - Criteria object

updateC - Criteria object

Throws:

java.lang.Exception - an unexpected exception

setBookingUpdateCriteriaWithStandardAttributes

protected void setBookingUpdateCriteriaWithStandardAttributes(AdminBookableProduct bProd,
                                                              com.konakart.db.KKCriteria selectC,
                                                              com.konakart.db.KKCriteria updateC)

Method that avoids duplication of code

Parameters:

bProd - the bProd

selectC - the selectC

updateC - the updateC

getBookableProduct

public AdminBookableProduct getBookableProduct(int productId)
                                        throws com.workingdogs.village.DataSetException,
                                               org.apache.torque.TorqueException,
                                               KKAdminException

Gets a Bookable Product object for a product id

Specified by:

getBookableProduct in interface AdminBookableProductMgrIf

Parameters:

productId - the productId

Returns:

Returns a Bookable Product 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

getBookableProduct

public AdminBookableProduct getBookableProduct(int productId,
                                               java.sql.Connection con)
                                        throws com.workingdogs.village.DataSetException,
                                               org.apache.torque.TorqueException,
                                               KKAdminException

Gets a Bookable Product object for a product id

Specified by:

getBookableProduct in interface AdminBookableProductMgrIf

Parameters:

productId - the productId

con - Connection for Transaction

Returns:

Returns a Bookable Product 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

setBookableProductCriteriaWithStandardAttributes

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

Set the standard attributes

Parameters:

c - the c

validateBookableProduct

protected void validateBookableProduct(AdminBookableProduct bProd,
                                       boolean checkProd)
                                throws KKAdminException

Validate the bookable product

Parameters:

bProd - the bProd

checkProd - Check to see whether product exists

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertBooking

public int insertBooking(AdminBooking booking,
                         AdminBookableProductOptions options)
                  throws KKAdminException,
                         org.apache.torque.TorqueException,
                         com.workingdogs.village.DataSetException

Inserts a Booking object into the database. The object must be associated with an existing product through the product id attribute.

Specified by:

insertBooking in interface AdminBookableProductMgrIf

Parameters:

booking - A booking object

options - AdminBookableProduct options

Returns:

Returns the id of the inserted object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

updateBookingCount

protected void updateBookingCount(int productId,
                                  AdminBookableProductOptions options,
                                  int numBookings)
                           throws KKAdminException,
                                  com.workingdogs.village.DataSetException,
                                  org.apache.torque.TorqueException

Update the number of bookings present

Parameters:

productId - the productId

options - the options

numBookings - Number of bookings being added or deleted (if negative)

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

getCfgMgr

private AdminConfigurationMgrIf getCfgMgr()
                                   throws KKAdminException

Throws:

KKAdminException

updateBooking

public void updateBooking(AdminBooking booking,
                          AdminBookableProductOptions options)
                   throws org.apache.torque.TorqueException,
                          KKAdminException,
                          com.workingdogs.village.DataSetException

This method is used to edit an existing booking. Attributes with null values will not be modified. The ProductId attribute of the booking must refer to an existing product.

Specified by:

updateBooking in interface AdminBookableProductMgrIf

Parameters:

booking - A booking object

options - AdminBookableProduct options

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

validateBooking

protected void validateBooking(AdminBooking booking,
                               int bookingQtyChange,
                               AdminBookableProductOptions options)
                        throws KKAdminException,
                               org.apache.torque.TorqueException,
                               com.workingdogs.village.DataSetException

Validate the booking

Parameters:

booking - the booking

bookingQtyChange - an integer that holds the change to the booking qty on the bookable product prior to the insert, update or delete of the specified booking. For inserts this number will be greater than or equal to 0, for updates it could be any value, and deletes it will be less than or equal to zero

options - AdminBookableProduct options

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

deleteBooking

public void deleteBooking(int bookingId,
                          AdminBookableProductOptions options)
                   throws java.lang.Exception

Delete the booking

Specified by:

deleteBooking in interface AdminBookableProductMgrIf

Parameters:

bookingId - the bookingId

options - AdminBookableProduct options

Throws:

java.lang.Exception - an unexpected exception

deleteBookableProduct

public void deleteBookableProduct(int productId)
                           throws org.apache.torque.TorqueException,
                                  KKAdminException,
                                  com.workingdogs.village.DataSetException

Delete the bookable Product

Specified by:

deleteBookableProduct in interface AdminBookableProductMgrIf

Parameters:

productId - the productId

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

deleteBookableProduct

public void deleteBookableProduct(int productId,
                                  java.sql.Connection con)
                           throws org.apache.torque.TorqueException,
                                  KKAdminException,
                                  com.workingdogs.village.DataSetException

Delete the bookable Product

Specified by:

deleteBookableProduct in interface AdminBookableProductMgrIf

Parameters:

productId - the productId

con - Connection for transaction

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getBooking

public AdminBooking getBooking(int bookingId,
                               AdminBookableProductOptions options)
                        throws org.apache.torque.TorqueException,
                               com.workingdogs.village.DataSetException,
                               KKAdminException

Return a booking by Id

Specified by:

getBooking in interface AdminBookableProductMgrIf

Parameters:

bookingId - the bookingId

options - AdminBookableProduct options

Returns:

Returns a booking

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

getBookingQty

public int getBookingQty(int bookingId,
                         AdminBookableProductOptions options)
                  throws org.apache.torque.TorqueException,
                         com.workingdogs.village.DataSetException,
                         KKAdminException

Return a booking by Id

Parameters:

bookingId - the booking Id

options - AdminBookableProductOptions

Returns:

Returns the Quantity attribute for the specified booking

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

getBookings

public AdminBookingSearchResult getBookings(AdminBookingSearch search,
                                            int offset,
                                            int size,
                                            AdminBookableProductOptions bookableProductOptions)
                                     throws org.apache.torque.TorqueException,
                                            com.workingdogs.village.DataSetException,
                                            KKAdminException

Method used to search for bookings.

Specified by:

getBookings in interface AdminBookableProductMgrIf

Parameters:

search - the search

offset - the offset

size - the size

bookableProductOptions - the bookableProductOptions

Returns:

Returns an array of bookings

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

getBookingCount

protected int getBookingCount(AdminBookingSearch search,
                              AdminBookableProductOptions options)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException,
                              KKAdminException

Get the number of bookings

Parameters:

search - the search

options - the options

Returns:

the number of bookings with the specified search 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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

setBookingCriteriaWithStandardAttributes

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

Set the standard attributes

Parameters:

c - the c

addBookingSearchCriteria

protected int addBookingSearchCriteria(com.konakart.db.KKCriteria c,
                                       AdminBookingSearch search,
                                       AdminBookableProductOptions options)

Add the search criteria

Parameters:

c - the c

search - the search

options - the options

Returns:

the number of constraints added

addBookingOrderBy

protected void addBookingOrderBy(com.konakart.db.KKCriteria c,
                                 AdminBookingSearch search)

Add the order by constraints

Parameters:

c - the c

search - the search

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the bookable product manager

Specified by:

refreshConfigs in interface AdminBookableProductMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception

getBookingCountMaxRetries

public static int getBookingCountMaxRetries()

Returns:

the bookingCountMaxRetries

setBookingCountMaxRetries

public static void setBookingCountMaxRetries(int bookingCountMaxRetries)

Parameters:

bookingCountMaxRetries - the bookingCountMaxRetries to set