com.konakart.bl

Class BookableProductMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.BookableProductMgr

All Implemented Interfaces:

BookableProductMgrIf

public class BookableProductMgr
extends BaseMgr
implements BookableProductMgrIf

The manager for bookable products

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BookableProductMgr.TimeSlot protected class used to store a start and end time

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
protected static int	LIMIT number of bookings to fetch at a time in a loop
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
BookableProductMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	doTimeSlotsOverlap(BookableProductMgr.TimeSlot ts1, BookableProductMgr.TimeSlot ts2) Returns true if the two time slots overlap
BookableProductIf	getBookableProduct(int productId, BookableProductOptionsIf options) Gets a Bookable Product object for a product id
Product[]	getBookableProductConflict(java.lang.String sessionId, ProductIf bookableProd, BookableProductOptionsIf options) This method checks to see whether the bookable product passed in as a parameter conflicts with any bookable products that the customer identified by the sessionId has already signed up for. If no conflicts are found, null is returned.
static int	getBookingCountMaxRetries()
protected Bookings	getBookingsPerCustomer(int customerId, DataDescriptorIf dataDescriptor) Get an array of bookings for a logged in customer.
Bookings	getBookingsPerCustomer(java.lang.String sessionId, DataDescriptorIf dataDesc, BookableProductOptionsIf options) Get an array of bookings for a logged in customer.
Bookings	getBookingsPerProduct(DataDescriptorIf dataDescriptor, int productId, BookableProductOptionsIf options) Get an array of bookings for a product.
protected int	getCount(KKCriteria c) This method is mainly used for paging.
protected int	getTimeInMins(java.lang.String timeStr) Calculates a time in minutes from a time representation in the format 00:13 or 12:45 etc.
protected java.util.ArrayList<BookableProductMgr.TimeSlot>	getTimeSlots(java.lang.String times) Returns an array of times slots from times encoded in a string in the format 10:45;11:30 15:00;16:00 where the delimiter between start and end is ";" and between times is a space
protected java.util.ArrayList<BookableProductMgr.TimeSlot>[]	getWeeklySchedule(ProductIf bookableProd) Returns an array 7 elements long where each element is for a day of the week.
int	insertBooking(BookingIf booking, BookableProductOptionsIf options) Inserts a Booking object into the database.
int	insertBooking(java.lang.String sessionId, BookingIf booking, BookableProductOptionsIf options) Inserts a Booking object into the database.
protected void	manageDataDescriptor(DataDescriptorIf dataDesc, KKCriteria c) Add constraints and order by criteria
void	refreshConfigs() Refresh the configuration of the bookable product manager
protected void	setBookableProductCriteriaWithStandardAttributes(KKCriteria c) Set the standard attributes
static void	setBookingCountMaxRetries(int bookingCountMaxRetries)
protected void	setBookingCriteriaWithStandardAttributes(KKCriteria c) Set the standard attributes
protected void	validateBooking(BookingIf booking, BookableProductOptionsIf options) Validate the booking

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

LIMIT

protected static final int LIMIT

number of bookings to fetch at a time in a loop

See Also:

Constant Field Values

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

Constructor Detail

BookableProductMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getBookingsPerProduct

public Bookings getBookingsPerProduct(DataDescriptorIf dataDescriptor,
                                      int productId,
                                      BookableProductOptionsIf options)
                               throws com.workingdogs.village.DataSetException,
                                      org.apache.torque.TorqueException,
                                      com.konakart.app.KKException

Get an array of bookings for a product. The DatDescriptor object may be used to add constraints on the custom fields and to add order by criteria. The following OrderBy criteria are implemented:

• DataDescConstants.ORDER_BY_DATE_ADDED_DESCENDING
• DataDescConstants.ORDER_BY_DATE_ADDED_ASCENDING
• DataDescConstants.ORDER_BY_FIRST_NAME_DESCENDING
• DataDescConstants.ORDER_BY_FIRST_NAME_ASCENDING
• DataDescConstants.ORDER_BY_LAST_NAME_DESCENDING
• DataDescConstants.ORDER_BY_LAST_NAME_ASCENDING
• DataDescConstants.ORDER_BY_ID

Specified by:

getBookingsPerProduct in interface BookableProductMgrIf

Parameters:

dataDescriptor - the dataDescriptor

productId - the productId

options - Not used at the moment. May be left null.

Returns:

Returns a Bookings 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)

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

getBookingsPerCustomer

public Bookings getBookingsPerCustomer(java.lang.String sessionId,
                                       DataDescriptorIf dataDesc,
                                       BookableProductOptionsIf options)
                                throws java.lang.Exception

Get an array of bookings for a logged in customer. The DatDescriptor object may be used to add constraints on the custom fields and to add order by criteria. The following OrderBy criteria are implemented:

• DataDescConstants.ORDER_BY_DATE_ADDED_DESCENDING
• DataDescConstants.ORDER_BY_DATE_ADDED_ASCENDING
• DataDescConstants.ORDER_BY_FIRST_NAME_DESCENDING
• DataDescConstants.ORDER_BY_FIRST_NAME_ASCENDING
• DataDescConstants.ORDER_BY_LAST_NAME_DESCENDING
• DataDescConstants.ORDER_BY_LAST_NAME_ASCENDING
• DataDescConstants.ORDER_BY_ID

Specified by:

getBookingsPerCustomer in interface BookableProductMgrIf

Parameters:

dataDesc - the dataDesc

sessionId - the sessionId

options - Not used at the moment. May be left null.

Returns:

Returns a Bookings object

Throws:

java.lang.Exception - an unexpected exception

getBookingsPerCustomer

protected Bookings getBookingsPerCustomer(int customerId,
                                          DataDescriptorIf dataDescriptor)
                                   throws java.lang.Exception

Get an array of bookings for a logged in customer. The DatDescriptor object may be used to add constraints on the custom fields and to add order by criteria. The following OrderBy criteria are implemented:

• DataDescConstants.ORDER_BY_DATE_ADDED_DESCENDING
• DataDescConstants.ORDER_BY_DATE_ADDED_ASCENDING
• DataDescConstants.ORDER_BY_FIRST_NAME_DESCENDING
• DataDescConstants.ORDER_BY_FIRST_NAME_ASCENDING
• DataDescConstants.ORDER_BY_LAST_NAME_DESCENDING
• DataDescConstants.ORDER_BY_LAST_NAME_ASCENDING
• DataDescConstants.ORDER_BY_ID

Parameters:

dataDescriptor - the dataDescriptor

customerId - the customerId

Returns:

Returns a Bookings object

Throws:

java.lang.Exception - an unexpected exception

setBookingCriteriaWithStandardAttributes

protected void setBookingCriteriaWithStandardAttributes(KKCriteria c)

Set the standard attributes

Parameters:

c - the c

manageDataDescriptor

protected void manageDataDescriptor(DataDescriptorIf dataDesc,
                                    KKCriteria c)

Add constraints and order by criteria

Parameters:

dataDesc - the dataDesc

c - the c

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)

insertBooking

public int insertBooking(BookingIf booking,
                         BookableProductOptionsIf options)
                  throws java.lang.Exception

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 BookableProductMgrIf

Parameters:

booking - A booking object

options - Options allowing an exception to be thrown for exceeding the maximum number of bookings

Returns:

Returns the id of the inserted object

Throws:

java.lang.Exception - an unexpected exception

insertBooking

public int insertBooking(java.lang.String sessionId,
                         BookingIf booking,
                         BookableProductOptionsIf options)
                  throws java.lang.Exception

Inserts a Booking object into the database. The customer must be logged in with a valid session id. The id of the logged in customer is written into the customerId attribute of the Booking object before it is saved. The object must be associated with an existing product through the product id attribute.

Specified by:

insertBooking in interface BookableProductMgrIf

Parameters:

sessionId - the sessionId

booking - A booking object

options - Options allowing an exception to be thrown for exceeding the maximum number of bookings

Returns:

Returns the id of the inserted object

Throws:

java.lang.Exception - an unexpected exception

validateBooking

protected void validateBooking(BookingIf booking,
                               BookableProductOptionsIf options)
                        throws java.lang.Exception

Validate the booking

Parameters:

booking - the booking

options - the options

Throws:

java.lang.Exception - an unexpected exception

getBookableProduct

public BookableProductIf getBookableProduct(int productId,
                                            BookableProductOptionsIf options)
                                     throws com.workingdogs.village.DataSetException,
                                            org.apache.torque.TorqueException,
                                            com.konakart.app.KKException

Gets a Bookable Product object for a product id

Specified by:

getBookableProduct in interface BookableProductMgrIf

Parameters:

productId - the productId

options - Not used at the moment. May be left null.

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)

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

setBookableProductCriteriaWithStandardAttributes

protected void setBookableProductCriteriaWithStandardAttributes(KKCriteria c)

Set the standard attributes

Parameters:

c - the c

getBookableProductConflict

public Product[] getBookableProductConflict(java.lang.String sessionId,
                                            ProductIf bookableProd,
                                            BookableProductOptionsIf options)
                                     throws java.lang.Exception

This method checks to see whether the bookable product passed in as a parameter conflicts with any bookable products that the customer identified by the sessionId has already signed up for.
If no conflicts are found, null is returned. If a conflict is found then an array of conflicting bookable products is returned.

Specified by:

getBookableProductConflict in interface BookableProductMgrIf

Parameters:

sessionId - the sessionId

bookableProd - the bookableProd

options - Not used at the moment. May be left null.

Returns:

Returns null for no conflict. Otherwise an array of conflicting products is returned.

Throws:

java.lang.Exception - an unexpected exception

doTimeSlotsOverlap

protected boolean doTimeSlotsOverlap(BookableProductMgr.TimeSlot ts1,
                                     BookableProductMgr.TimeSlot ts2)

Returns true if the two time slots overlap

Parameters:

ts1 - the ts1

ts2 - the ts2

Returns:

Returns true if the two time slots overlap

getWeeklySchedule

protected java.util.ArrayList<BookableProductMgr.TimeSlot>[] getWeeklySchedule(ProductIf bookableProd)
                                                                        throws com.konakart.app.KKException

Returns an array 7 elements long where each element is for a day of the week. Each element may contain an arrayList containing time slots for that day.

Parameters:

bookableProd - the bookableProd

Returns:

returns the weekly schedule (see above)

Throws:

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

getTimeSlots

protected java.util.ArrayList<BookableProductMgr.TimeSlot> getTimeSlots(java.lang.String times)
                                                                 throws com.konakart.app.KKException

Returns an array of times slots from times encoded in a string in the format 10:45;11:30 15:00;16:00 where the delimiter between start and end is ";" and between times is a space

Parameters:

times - the times

Returns:

Returns a list of TimeSlot objects

Throws:

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

getTimeInMins

protected int getTimeInMins(java.lang.String timeStr)
                     throws com.konakart.app.KKException

Calculates a time in minutes from a time representation in the format 00:13 or 12:45 etc.

Parameters:

timeStr - the timeStr

Returns:

Returns the time in minutes

Throws:

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

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the bookable product manager

Specified by:

refreshConfigs in interface BookableProductMgrIf

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