com.konakartadmin.blif

Interface AdminReviewMgrIf

All Known Implementing Classes:

AdminReviewMgr, AdminReviewMgrEE

public interface AdminReviewMgrIf

AdminReviewMgrIf

Method Summary

Modifier and Type	Method and Description
void	deleteReview(int reviewId) Delete the review referenced to by reviewId.
void	deleteReviewsPerCustomer(int customerId) Delete all the reviews written by a customer.
void	deleteReviewsPerProduct(int productId, java.sql.Connection connection) Delete the reviews for the product identified by productId.
void	deleteReviewsPerProducts(int[] productIds, java.sql.Connection connection) Delete the reviews for the products identified by the productIds array.
void	deleteReviewsPerVendor(int vendorId, java.sql.Connection connection) Delete the reviews for the vendor identified by the vendorId.
void	deleteVendorReview(int reviewId) Delete the vendor review referenced to by reviewId.
void	deleteVendorReviewsPerCustomer(int customerId) Delete all the vendor reviews written by a customer.
void	editReview(AdminReview review) Edit a review
AdminReviews	getAllReviews(AdminDataDescriptor dataDesc) Calls the getReviewsPerProduct method with a negative productId value so that it is not included in the Where clause of the query
AdminReview	getReview(int reviewId) Returns a review for the given reviewId
AdminReviews	getReviews(AdminDataDescriptor dataDesc, AdminReviewSearch revSearch) Returns an array of reviews for the given search criteria.
AdminReviews	getReviewsPerProduct(AdminDataDescriptor dataDesc, int productId) Returns an array of reviews for the given productId
AdminReviews	getReviewsPerVendor(AdminDataDescriptor dataDesc, int vendorId) Returns an array of vendor reviews for the given vendorId
AdminReview	getVendorReview(int reviewId) Returns a vendor review for the given reviewId
AdminReviews	getVendorReviews(AdminDataDescriptor dataDesc, AdminReviewSearch revSearch) Returns an array of vendor reviews for the given search criteria.
int	insertReview(AdminReview review) A new review is inserted.

Method Detail

getAllReviews

AdminReviews getAllReviews(AdminDataDescriptor dataDesc)
                    throws org.apache.torque.TorqueException,
                           com.workingdogs.village.DataSetException,
                           KKAdminException

Calls the getReviewsPerProduct method with a negative productId value so that it is not included in the Where clause of the query

Parameters:

dataDesc - the dataDesc

Returns:

Returns all reviews

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

getReviewsPerProduct

AdminReviews getReviewsPerProduct(AdminDataDescriptor dataDesc,
                                  int productId)
                           throws org.apache.torque.TorqueException,
                                  com.workingdogs.village.DataSetException,
                                  KKAdminException

Returns an array of reviews for the given productId

Parameters:

dataDesc - the dataDesc

productId - the productId

Returns:

Returns a Reviews object

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

getReviews

AdminReviews getReviews(AdminDataDescriptor dataDesc,
                        AdminReviewSearch revSearch)
                 throws org.apache.torque.TorqueException,
                        com.workingdogs.village.DataSetException,
                        KKAdminException

Returns an array of reviews for the given search criteria.

Parameters:

dataDesc - the dataDesc

revSearch - the revSearch

Returns:

Returns a Reviews object

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

getReview

AdminReview getReview(int reviewId)
               throws org.apache.torque.TorqueException,
                      com.workingdogs.village.DataSetException,
                      KKAdminException

Returns a review for the given reviewId

Parameters:

reviewId - the reviewId

Returns:

Returns a Review object

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

deleteReview

void deleteReview(int reviewId)
           throws java.lang.Exception

Delete the review referenced to by reviewId.

Parameters:

reviewId - the reviewId

Throws:

java.lang.Exception - an unexpected exception

deleteVendorReview

void deleteVendorReview(int reviewId)
                 throws java.lang.Exception

Delete the vendor review referenced to by reviewId.

Parameters:

reviewId - the reviewId

Throws:

java.lang.Exception - an unexpected exception

deleteReviewsPerProduct

void deleteReviewsPerProduct(int productId,
                             java.sql.Connection connection)
                      throws java.lang.Exception

Delete the reviews for the product identified by productId. If connection is not equal to null, it is used so that this delete may be part of a transaction started somewhere else.

Parameters:

productId - the productId

connection - the connection

Throws:

java.lang.Exception - an unexpected exception

deleteReviewsPerProducts

void deleteReviewsPerProducts(int[] productIds,
                              java.sql.Connection connection)
                       throws java.lang.Exception

Delete the reviews for the products identified by the productIds array. If connection is not equal to null, it is used so that this delete may be part of a transaction started somewhere else.

Parameters:

productIds - the productIds

connection - the connection

Throws:

java.lang.Exception - an unexpected exception

editReview

void editReview(AdminReview review)
         throws java.lang.Exception

Edit a review

Parameters:

review - the review

Throws:

java.lang.Exception - an unexpected exception

insertReview

int insertReview(AdminReview review)
          throws java.lang.Exception

A new review is inserted. If the customerId on the review is 0 the name used for the review will be the customerName passed in on the review. If the customerId on the review is not 0 the name used for the review will be calculated by looking up the customer with the specified customerId then formatting the customer's name according to the definition of the NAME_FORMAT_TEMPLATE. Therefore, if the customerId is not 0 it must be the Id of a customer otherwise an Exception will be thrown.

Parameters:

review - the review

Returns:

Review Primary Key

Throws:

java.lang.Exception - an unexpected exception

deleteReviewsPerVendor

void deleteReviewsPerVendor(int vendorId,
                            java.sql.Connection connection)
                     throws java.lang.Exception

Delete the reviews for the vendor identified by the vendorId. If connection is not equal to null, it is used so that this delete may be part of a transaction started somewhere else.

Parameters:

vendorId - the vendorId

connection - the connection

Throws:

java.lang.Exception - an unexpected exception

getReviewsPerVendor

AdminReviews getReviewsPerVendor(AdminDataDescriptor dataDesc,
                                 int vendorId)
                          throws org.apache.torque.TorqueException,
                                 com.workingdogs.village.DataSetException,
                                 KKAdminException

Returns an array of vendor reviews for the given vendorId

Parameters:

dataDesc - the dataDesc

vendorId - the vendorId

Returns:

Returns a Reviews object

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

getVendorReviews

AdminReviews getVendorReviews(AdminDataDescriptor dataDesc,
                              AdminReviewSearch revSearch)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException,
                              KKAdminException

Returns an array of vendor reviews for the given search criteria.

Parameters:

dataDesc - the dataDesc

revSearch - the revSearch

Returns:

Returns a Reviews object

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

getVendorReview

AdminReview getVendorReview(int reviewId)
                     throws org.apache.torque.TorqueException,
                            com.workingdogs.village.DataSetException,
                            KKAdminException

Returns a vendor review for the given reviewId

Parameters:

reviewId - the reviewId

Returns:

Returns a Review object

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

deleteReviewsPerCustomer

void deleteReviewsPerCustomer(int customerId)
                       throws java.lang.Exception

Delete all the reviews written by a customer.

Parameters:

customerId - the id of the customer that wrote the reviews

Throws:

java.lang.Exception - an unexpected exception

deleteVendorReviewsPerCustomer

void deleteVendorReviewsPerCustomer(int customerId)
                             throws java.lang.Exception

Delete all the vendor reviews written by a customer.

Parameters:

customerId - the id of the customer that wrote the reviews

Throws:

java.lang.Exception - an unexpected exception