com.konakartadmin.bl

Class AdminReviewMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminReviewMgr

All Implemented Interfaces:

AdminReviewMgrIf

Direct Known Subclasses:

AdminReviewMgrEE

public class AdminReviewMgr
extends AdminBaseMgr
implements AdminReviewMgrIf

The AdminReviewMgr - for Managing Review Objects for the Admin Application

Nested Class Summary

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBaseMgr

AdminBaseMgr.StaticData

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRODUCT_REVIEW Product review
static int	VENDOR_REVIEW Vendor review

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
AdminReviewMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	deleteReview(int reviewId) Delete the review referenced to by reviewId.
void	deleteReview(int reviewId, int revType) Delete the review referenced to by reviewId.
void	deleteReviewsPerCustomer(int customerId) Delete all the reviews written by a customer.
protected void	deleteReviewsPerCustomer(int customerId, int revType) 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 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
protected int	getCount(com.konakart.db.KKCriteria c) This method is mainly used for paging.
protected com.konakart.db.KKCriteria	getCriteria(int revType) Returns a KKCriteria object based on the review type
protected AdminReview	getLightReview(int reviewId, int revType) Returns a review just populated with the product and vendor IDs.
AdminReview	getReview(int reviewId) Returns a review for the given reviewId
AdminReview	getReview(int reviewId, int revType) Returns a review for the given reviewId
AdminReviews	getReviews(AdminDataDescriptor dataDesc, AdminReviewSearch revSearch) Returns an array of reviews for the given search criteria.
protected AdminReviews	getReviews(AdminDataDescriptor dataDesc, AdminReviewSearch revSearch, int revType) 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 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 reviews for the given search criteria.
int	insertReview(AdminReview review) A new review is inserted
protected void	manageDataDescriptor(AdminDataDescriptor dataDesc, com.konakart.db.KKCriteria c) Provides common code to deal with the management of the DataDescriptor
protected void	setCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c, int revType) Initialize criteria with review attributes
protected void	validateReview(AdminReview review) Validate the review

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

PRODUCT_REVIEW

public static final int PRODUCT_REVIEW

Product review

See Also:

Constant Field Values

VENDOR_REVIEW

public static final int VENDOR_REVIEW

Vendor review

See Also:

Constant Field Values

Constructor Detail

AdminReviewMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getAllReviews

public 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

Specified by:

getAllReviews in interface AdminReviewMgrIf

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 - unexpected exception in the KonaKart Admin Engine

getReviewsPerProduct

public 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

Specified by:

getReviewsPerProduct in interface AdminReviewMgrIf

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 - unexpected exception in the KonaKart Admin Engine

getReviews

public 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.

Specified by:

getReviews in interface AdminReviewMgrIf

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 - unexpected exception in the KonaKart Admin Engine

getReviews

protected AdminReviews getReviews(AdminDataDescriptor dataDesc,
                                  AdminReviewSearch revSearch,
                                  int revType)
                           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

revType - the revType

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 - unexpected exception in the KonaKart Admin Engine

getReview

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

Returns a review for the given reviewId

Specified by:

getReview in interface AdminReviewMgrIf

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 - unexpected exception in the KonaKart Admin Engine

getReview

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

Returns a review for the given reviewId

Parameters:

reviewId - the reviewId

revType - the revType

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 - unexpected exception in the KonaKart Admin Engine

getLightReview

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

Returns a review just populated with the product and vendor IDs.

Parameters:

reviewId - the reviewId

revType - the revType

Returns:

Returns a review just populated with the product and vendor IDs.

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 - unexpected exception in the KonaKart Admin Engine

deleteReview

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

Delete the review referenced to by reviewId.

Specified by:

deleteReview in interface AdminReviewMgrIf

Parameters:

reviewId - the reviewId

Throws:

java.lang.Exception - an unexpected exception

deleteReview

public void deleteReview(int reviewId,
                         int revType)
                  throws java.lang.Exception

Delete the review referenced to by reviewId.

Parameters:

reviewId - the reviewId

revType - the revType

Throws:

java.lang.Exception - an unexpected exception

deleteReviewsPerCustomer

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

Delete all the reviews written by a customer.

Specified by:

deleteReviewsPerCustomer in interface AdminReviewMgrIf

Parameters:

customerId - the id of the customer that wrote the reviews

Throws:

java.lang.Exception - an unexpected exception

deleteVendorReviewsPerCustomer

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

Delete all the vendor reviews written by a customer.

Specified by:

deleteVendorReviewsPerCustomer in interface AdminReviewMgrIf

Parameters:

customerId - the id of the customer that wrote the reviews

Throws:

java.lang.Exception - an unexpected exception

deleteReviewsPerCustomer

protected void deleteReviewsPerCustomer(int customerId,
                                        int revType)
                                 throws java.lang.Exception

Delete all the reviews written by a customer.

Parameters:

customerId - the id of the customer that wrote the reviews

revType - the revType

Throws:

java.lang.Exception - an unexpected exception

deleteReviewsPerProduct

public 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.

Specified by:

deleteReviewsPerProduct in interface AdminReviewMgrIf

Parameters:

productId - the productId

connection - the connection

Throws:

java.lang.Exception - an unexpected exception

deleteReviewsPerProducts

public 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.

Specified by:

deleteReviewsPerProducts in interface AdminReviewMgrIf

Parameters:

productIds - the productIds

connection - the connection

Throws:

java.lang.Exception - an unexpected exception

editReview

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

Edit a review

Specified by:

editReview in interface AdminReviewMgrIf

Parameters:

review - the review

Throws:

java.lang.Exception - an unexpected exception

insertReview

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

A new review is inserted

Specified by:

insertReview in interface AdminReviewMgrIf

Parameters:

review - the review

Returns:

int : Review Primary Key

Throws:

java.lang.Exception - an unexpected exception

manageDataDescriptor

protected void manageDataDescriptor(AdminDataDescriptor dataDesc,
                                    com.konakart.db.KKCriteria c)

Provides common code to deal with the management of the DataDescriptor

Parameters:

dataDesc - the dataDesc

c - the c

validateReview

protected void validateReview(AdminReview review)
                       throws java.lang.Exception

Validate the review

Parameters:

review - the review

Throws:

java.lang.Exception - an unexpected exception

getCount

protected int getCount(com.konakart.db.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)

setCriteriaWithStandardAttributes

protected void setCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c,
                                                 int revType)
                                          throws KKAdminException

Initialize criteria with review attributes

Parameters:

c - the c

revType - the revType

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getCriteria

protected com.konakart.db.KKCriteria getCriteria(int revType)
                                          throws KKAdminException

Returns a KKCriteria object based on the review type

Parameters:

revType - the revType

Returns:

Returns a KKCriteria object based on the review type

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getVendorReview

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

Returns a vendor review for the given reviewId

Specified by:

getVendorReview in interface AdminReviewMgrIf

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 - unexpected exception in the KonaKart Admin Engine

getReviewsPerVendor

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

Returns an array of reviews for the given vendorId

Specified by:

getReviewsPerVendor in interface AdminReviewMgrIf

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 - unexpected exception in the KonaKart Admin Engine

getVendorReviews

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

Returns an array of reviews for the given search criteria.

Specified by:

getVendorReviews in interface AdminReviewMgrIf

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 - unexpected exception in the KonaKart Admin Engine

deleteVendorReview

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

Delete the review referenced to by reviewId.

Specified by:

deleteVendorReview in interface AdminReviewMgrIf

Parameters:

reviewId - the reviewId

Throws:

java.lang.Exception - an unexpected exception

deleteReviewsPerVendor

public 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.

Specified by:

deleteReviewsPerVendor in interface AdminReviewMgrIf

Parameters:

vendorId - the vendorId

connection - the connection

Throws:

java.lang.Exception - an unexpected exception