com.konakart.blif

Interface ReviewMgrIf

All Known Implementing Classes:

ReviewMgr, ReviewMgrEE

public interface ReviewMgrIf

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

Method Summary

Modifier and Type	Method and Description
void	escapeReview(ReviewIf review) Escape the Strings in the Review object using the rules defined in the properties file by the property konakart.escape.chars .
Reviews	getAllReviews(DataDescriptorIf dataDesc) Calls the getReviewsPerProduct method with a negative productId value so that it is not included in the Where clause of the query
Review	getReview(int reviewId) Returns a review for the given reviewId
Reviews	getReviews(DataDescriptorIf dataDesc, ReviewSearchIf search) Returns an array of Reviews (within a Reviews object) that match the specified search criteria in the ReviewSearch object.
Reviews	getReviewsPerProduct(DataDescriptorIf dataDesc, int productId) Returns an array of reviews for the given productId
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 dataDesc, ReviewSearchIf search) Returns an array of Reviews (within a Reviews object) that match the specified search criteria in the ReviewSearch object.
int	writeReview(java.lang.String sessionId, ReviewIf review) A new customer review is added to the system.

Method Detail

getAllReviews

Reviews getAllReviews(DataDescriptorIf dataDesc)
               throws org.apache.torque.TorqueException,
                      com.workingdogs.village.DataSetException,
                      com.konakart.app.KKException

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)

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

getReviewsPerProduct

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

Returns an array of reviews for the given productId

Parameters:

dataDesc - the dataDesc

productId - the productId

Returns:

Returns a Reviews object containing the return data

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

getReview

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

Returns a review for the given reviewId

Parameters:

reviewId - the reviewId

Returns:

Returns a Reviews object containing the return data

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

getReviews

Reviews getReviews(DataDescriptorIf dataDesc,
                   ReviewSearchIf search)
            throws org.apache.torque.TorqueException,
                   com.workingdogs.village.DataSetException,
                   com.konakart.app.KKException

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 product identified by the productId
• 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

Parameters:

dataDesc - The data descriptor object that defines the sort order, constraints on custom fields and offset and limit for paging.

search - The Review search object that defines the search criteria

Returns:

Returns a Reviews object containing the return data

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

writeReview

int writeReview(java.lang.String sessionId,
                ReviewIf review)
         throws java.lang.Exception

A new customer review is added to the system. The process for adding a new review is to :

1. Get the customer's id from the session
2. Get the customer's name from the CustomerMgr
3. Write into the reviews table followed by the reviews description table in one transaction

All of the above actions are performed as a transaction. In the case of MySQL, the transaction doesn't work unless the tables are defined as using the InnoDB or BDB engines. A table can be transformed using the following syntax : Alter table t Engine = InnoDB;. The standard engine seems to be MyIsam which doesn't support transactions.

Parameters:

sessionId - the sessionId

review - the review

Returns:

int : Review Primary Key or a negative value for an error

Throws:

java.lang.Exception - an unexpected exception

escapeReview

void escapeReview(ReviewIf review)

Escape the Strings in the Review object using the rules defined in the properties file by the property konakart.escape.chars . This method may be overridden in a custom manager to add exceptions for attributes that don't need to be escaped or to disable the escaping completely.

Parameters:

review - the review

getVendorReviews

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

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

Parameters:

dataDesc - The data descriptor object that defines the sort order, constraints on custom fields and offset and limit for paging.

search - The Review search object that defines the search criteria

Returns:

Returns a Reviews object containing the return data

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

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

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

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

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