com.konakartadmin.blif

Interface AdminBookableProductMgrIf

All Known Implementing Classes:

AdminBookableProductMgr

public interface AdminBookableProductMgrIf

AdminBookableProductMgrIf

Method Summary

Modifier and Type	Method and Description
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
AdminBookingSearchResult	getBookings(AdminBookingSearch search, int offset, int size, AdminBookableProductOptions bookableProductOptions) Method used to search for bookings.
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() Update the caches
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.

Method Detail

insertBookableProduct

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.

Parameters:

bProd - A bookable product object

Throws:

java.lang.Exception - an unexpected exception

insertBookableProduct

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.

Parameters:

bProd - A bookable product object

con - Database connection

insertC - Criteria object

Throws:

java.lang.Exception - an unexpected exception

updateBookableProduct

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.

Parameters:

bProd - A bookable product object

Throws:

java.lang.Exception - an unexpected exception

updateBookableProduct

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.

Parameters:

bProd - A bookable product object

con - Database connection

selectC - Criteria object

updateC - Criteria object

Throws:

java.lang.Exception - an unexpected exception

getBookableProduct

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

Gets a Bookable Product object for a product id

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

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

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

insertBooking

int insertBooking(AdminBooking booking,
                  AdminBookableProductOptions options)
           throws java.lang.Exception

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

Parameters:

booking - A booking object

options - AdminBookableProduct options

Returns:

Returns the id of the inserted object

Throws:

java.lang.Exception - an unexpected exception

updateBooking

void updateBooking(AdminBooking booking,
                   AdminBookableProductOptions options)
            throws java.lang.Exception

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

Parameters:

booking - A booking object

options - AdminBookableProduct options

Throws:

java.lang.Exception - an unexpected exception

deleteBooking

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

Delete the booking

Parameters:

bookingId - the bookingId

options - AdminBookableProduct options

Throws:

java.lang.Exception - an unexpected exception

getBooking

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

Return a booking by Id

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

getBookings

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.

Parameters:

search - the search

offset - the offset

size - the size

bookableProductOptions - AdminBookableProduct options

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

deleteBookableProduct

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

Delete the bookable Product.

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

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

Delete the bookable Product.

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)

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Update the caches

Throws:

java.lang.Exception - an unexpected exception