com.konakart.blif

Interface BookableProductMgrIf

All Known Implementing Classes:

BookableProductMgr

public interface BookableProductMgrIf

BookableMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
void	refreshConfigs() Get the config variables needed to setup the Bookable Product Mgr

Method Detail

getBookingsPerProduct

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

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

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

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

getBookableProduct

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

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

insertBooking

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.

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

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.

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

getBookableProductConflict

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.

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

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Get the config variables needed to setup the Bookable Product Mgr

Throws:

java.lang.Exception - an unexpected exception