com.konakart.bl

Class RewardPointMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.RewardPointMgr

All Implemented Interfaces:

RewardPointMgrIf

public class RewardPointMgr
extends BaseMgr
implements RewardPointMgrIf

Reward point manager - Uses RewardPointCore for business logic

Field Summary

Fields

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

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
RewardPointMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
int	addPoints(int customerId, int points, java.lang.String code, java.lang.String description) Adds a number of reward points to the total for customer identified by the sessionId parameter.
int	addPoints(java.lang.String sessionId, int points, java.lang.String code, java.lang.String description) Adds a number of reward points to the total for customer identified by the sessionId parameter.
int	deletePoints(int customerId, int points, java.lang.String code, java.lang.String description) Deletes a number of reward points from the total for the customer identified by the sessionId parameter.
int	deletePoints(java.lang.String sessionId, int points, java.lang.String code, java.lang.String description) Deletes a number of reward points from the total for the customer identified by the sessionId parameter.
void	deleteReservedPoints(int customerId, int reservationId, java.lang.String code, java.lang.String description) Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter.
void	deleteReservedPoints(java.lang.String sessionId, int reservationId, java.lang.String code, java.lang.String description) Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter.
int	freeReservedPoints(int customerId, int reservationId) Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter.
int	freeReservedPoints(java.lang.String sessionId, int reservationId) Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter.
protected int	getCount(KKCriteria c) This method is mainly used for paging.
protected int	getReservationId() Get a unique reservation id from the counter table
RewardPoints	getRewardPoints(java.lang.String sessionId, DataDescriptorIf dataDesc) Gets an array of reward point objects for a customer identified by the sessionId parameter.
RewardPoints	getRewardPointsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDescriptor, FetchRewardPointOptionsIf options) Gets an array of reward point objects for a customer identified by the sessionId parameter.
int	pointsAvailable(int customerId) Calculates the number of reward points available for the customer identified by the sessionId parameter.
int	pointsAvailable(java.lang.String sessionId) Calculates the number of reward points available for the customer identified by the sessionId parameter.
int	reservePoints(int customerId, int points) Removes a number of reward points from the total for the customer identified by the sessionId parameter.
int	reservePoints(java.lang.String sessionId, int points) Removes a number of reward points from the total for the customer identified by the sessionId parameter.

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

Field Detail

log

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

Constructor Detail

RewardPointMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

pointsAvailable

public int pointsAvailable(java.lang.String sessionId)
                    throws java.lang.Exception

Calculates the number of reward points available for the customer identified by the sessionId parameter.

Specified by:

pointsAvailable in interface RewardPointMgrIf

Parameters:

sessionId - the sessionId

Returns:

Returns the number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

pointsAvailable

public int pointsAvailable(int customerId)
                    throws java.lang.Exception

Calculates the number of reward points available for the customer identified by the sessionId parameter.

Specified by:

pointsAvailable in interface RewardPointMgrIf

Parameters:

customerId - the customerId

Returns:

Returns the number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

addPoints

public int addPoints(java.lang.String sessionId,
                     int points,
                     java.lang.String code,
                     java.lang.String description)
              throws java.lang.Exception

Adds a number of reward points to the total for customer identified by the sessionId parameter.

Specified by:

addPoints in interface RewardPointMgrIf

Parameters:

sessionId - the sessionId

points - the points

code - An optional code to categorize the reason for awarding the points

description - An optional description describing why the points were awarded

Returns:

Returns the new number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

addPoints

public int addPoints(int customerId,
                     int points,
                     java.lang.String code,
                     java.lang.String description)
              throws java.lang.Exception

Adds a number of reward points to the total for customer identified by the sessionId parameter.

Specified by:

addPoints in interface RewardPointMgrIf

Parameters:

customerId - the customerId

points - the points

code - An optional code to categorize the reason for awarding the points

description - An optional description describing why the points were awarded

Returns:

Returns the new number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

deletePoints

public int deletePoints(java.lang.String sessionId,
                        int points,
                        java.lang.String code,
                        java.lang.String description)
                 throws java.lang.Exception

Deletes a number of reward points from the total for the customer identified by the sessionId parameter.

Specified by:

deletePoints in interface RewardPointMgrIf

Parameters:

sessionId - the sessionId

points - the points

code - An optional code to categorize the reason for redeeming the points

description - An optional description describing how the points were redeemed

Returns:

Returns the new number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

deletePoints

public int deletePoints(int customerId,
                        int points,
                        java.lang.String code,
                        java.lang.String description)
                 throws java.lang.Exception

Deletes a number of reward points from the total for the customer identified by the sessionId parameter.

Specified by:

deletePoints in interface RewardPointMgrIf

Parameters:

customerId - the customerId

points - the points

code - An optional code to categorize the reason for redeeming the points

description - An optional description describing how the points were redeemed

Returns:

Returns the new number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

reservePoints

public int reservePoints(java.lang.String sessionId,
                         int points)
                  throws java.lang.Exception

Removes a number of reward points from the total for the customer identified by the sessionId parameter. The removed points are not deleted but reserved, so that they are no longer available for spending but may be deleted once the order has been paid for or shipped. If the order is never fulfilled, then the reserved points may be freed and returned to the available total.

Specified by:

reservePoints in interface RewardPointMgrIf

Parameters:

sessionId - the sessionId

points - the points

Returns:

Returns the reservation id of the reserved points

Throws:

java.lang.Exception - an unexpected exception

reservePoints

public int reservePoints(int customerId,
                         int points)
                  throws java.lang.Exception

Removes a number of reward points from the total for the customer identified by the sessionId parameter. The removed points are not deleted but reserved, so that they are no longer available for spending but may be deleted once the order has been paid for or shipped. If the order is never fulfilled, then the reserved points may be freed and returned to the available total.

Specified by:

reservePoints in interface RewardPointMgrIf

Parameters:

customerId - the customerId

points - the points

Returns:

Returns the reservation id of the reserved points

Throws:

java.lang.Exception - an unexpected exception

deleteReservedPoints

public void deleteReservedPoints(java.lang.String sessionId,
                                 int reservationId,
                                 java.lang.String code,
                                 java.lang.String description)
                          throws java.lang.Exception

Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter. The reserved points are normally deleted once the order has been paid for or shipped. If the order is never fulfilled, then the reserved points may be freed and returned to the available total. Once deleted. the points can no longer be returned to the total.

Specified by:

deleteReservedPoints in interface RewardPointMgrIf

Parameters:

sessionId - the sessionId

reservationId - the reservationId

code - An optional code to categorize the reason for redeeming the points

description - An optional description describing how the points were redeemed

Throws:

java.lang.Exception - an unexpected exception

deleteReservedPoints

public void deleteReservedPoints(int customerId,
                                 int reservationId,
                                 java.lang.String code,
                                 java.lang.String description)
                          throws java.lang.Exception

Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter. The reserved points are normally deleted once the order has been paid for or shipped. If the order is never fulfilled, then the reserved points may be freed and returned to the available total. Once deleted. the points can no longer be returned to the total.

Specified by:

deleteReservedPoints in interface RewardPointMgrIf

Parameters:

customerId - the customerId

reservationId - the reservationId

code - An optional code to categorize the reason for redeeming the points

description - An optional description describing how the points were redeemed

Throws:

java.lang.Exception - an unexpected exception

freeReservedPoints

public int freeReservedPoints(java.lang.String sessionId,
                              int reservationId)
                       throws java.lang.Exception

Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter. The reserved points may be freed and returned to the available total using this API call. The method checks to see whether some or all of the points have expired while they were in the reserved state.

Specified by:

freeReservedPoints in interface RewardPointMgrIf

Parameters:

sessionId - the sessionId

reservationId - the reservationId

Returns:

Returns the number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

freeReservedPoints

public int freeReservedPoints(int customerId,
                              int reservationId)
                       throws java.lang.Exception

Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter. The reserved points may be freed and returned to the available total using this API call. The method checks to see whether some or all of the points have expired while they were in the reserved state.

Specified by:

freeReservedPoints in interface RewardPointMgrIf

Parameters:

customerId - the customerId

reservationId - the reservationId

Returns:

Returns the number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

getReservationId

protected int getReservationId()
                        throws java.lang.Exception

Get a unique reservation id from the counter table

Returns:

Returns a unique reservation id

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

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

java.lang.Exception

getRewardPointsWithOptions

public RewardPoints getRewardPointsWithOptions(java.lang.String sessionId,
                                               DataDescriptorIf dataDescriptor,
                                               FetchRewardPointOptionsIf options)
                                        throws java.lang.Exception

Gets an array of reward point objects for a customer identified by the sessionId parameter.

Specified by:

getRewardPointsWithOptions in interface RewardPointMgrIf

Parameters:

sessionId - the sessionId

dataDescriptor - the dataDescriptor

options - the options

Returns:

Returns a RewardPoints object

Throws:

java.lang.Exception - an unexpected exception

getRewardPoints

public RewardPoints getRewardPoints(java.lang.String sessionId,
                                    DataDescriptorIf dataDesc)
                             throws java.lang.Exception

Gets an array of reward point objects for a customer identified by the sessionId parameter.

Specified by:

getRewardPoints in interface RewardPointMgrIf

Parameters:

sessionId - the sessionId

dataDesc - the dataDesc

Returns:

Returns a RewardPoints object

Throws:

java.lang.Exception - an unexpected exception

getCount

protected int getCount(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)