com.konakart.bl

Class ReviewMgrEE

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.ReviewMgr

com.konakart.bl.ReviewMgrEE

All Implemented Interfaces:

ReviewMgrIf

public class ReviewMgrEE
extends ReviewMgr
implements ReviewMgrIf

Reviews Manager Enterprise

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log Log

Fields inherited from class com.konakart.bl.ReviewMgr

PRODUCT_REVIEW, VENDOR_REVIEW

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
ReviewMgrEE(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
Reviews	getReviewsPerVendor(DataDescriptorIf dataDesc, int vendorId) Returns an array of reviews for the given vendorId
Review	getVendorReview(int reviewId) Returns a vendor review for the given reviewId
Reviews	getVendorReviews(DataDescriptorIf dataDescIn, ReviewSearchIf searchIn) Returns an array of Reviews (within a Reviews object) that match the specified search criteria in the ReviewSearch object.

Methods inherited from class com.konakart.bl.ReviewMgr

escapeReview, getAllReviews, getCount, getCriteria, getReview, getReviews, getReviews, getReviewsPerProduct, manageDataDescriptor, writeReview

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

Methods inherited from interface com.konakart.blif.ReviewMgrIf

escapeReview, getAllReviews, getReview, getReviews, getReviewsPerProduct, writeReview

Field Detail

log

protected static org.apache.commons.logging.Log log

Log

Constructor Detail

ReviewMgrEE

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getVendorReviews

public Reviews getVendorReviews(DataDescriptorIf dataDescIn,
                                ReviewSearchIf searchIn)
                         throws org.apache.torque.TorqueException,
                                com.workingdogs.village.DataSetException,
                                com.konakart.app.KKException

Description copied from interface: ReviewMgrIf

Returns an array of Reviews (within a Reviews object) that match the specified search criteria in the ReviewSearch object. It allows you to search for:

• A review for a given reviewId
• All reviews for a vendor identified by the vendorId
• All reviews written by a customer identified by the customerId
• All reviews matching, above or below a given rating

The ReviewSearch object also allows you to specify that the return data contains:

• The average rating for all reviews matching the search criteria.
• An array of name / number objects containing facet information for the number of reviews present for each rating. The name identifies the rating and the number identifies the number of reviews for that rating. No object is returned for a rating that has no reviews.

dataDesc controls the following functionality:

• The maximum number of Review objects returned.
• The offset which defaults to zero. This is useful when there are many Review objects, in order to return them using multiple calls to this method.
• Criteria on the custom attributes. If a custom attribute is set then only reviews with a matching custom attribute value are returned.
• The Reviews may be sorted by :
  • com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_LAST_MODIFIED_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_LAST_MODIFIED_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_TIMES_READ_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_TIMES_READ_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_RATING_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_RATING_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_DESCENDING

Specified by:

getVendorReviews in interface ReviewMgrIf

Overrides:

getVendorReviews in class ReviewMgr

Parameters:

dataDescIn - the dataDescIn

searchIn - the searchIn

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)

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

getVendorReview

public Review getVendorReview(int reviewId)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException,
                              com.konakart.app.KKException

Returns a vendor review for the given reviewId

Specified by:

getVendorReview in interface ReviewMgrIf

Overrides:

getVendorReview in class ReviewMgr

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)

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

getReviewsPerVendor

public Reviews getReviewsPerVendor(DataDescriptorIf dataDesc,
                                   int vendorId)
                            throws org.apache.torque.TorqueException,
                                   com.workingdogs.village.DataSetException,
                                   com.konakart.app.KKException

Returns an array of reviews for the given vendorId

Specified by:

getReviewsPerVendor in interface ReviewMgrIf

Overrides:

getReviewsPerVendor in class ReviewMgr

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)

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