com.konakart.bl

Class RewardPointCore

java.lang.Object

com.konakart.bl.RewardPointCore

public class RewardPointCore
extends java.lang.Object

Reward point core which is used by both the RewardPointMgr and the AdminRewardPointMgr

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log
static int	TX_TYPE_ADD_POINTS Transaction type
static int	TX_TYPE_REMOVE_POINTS Transaction type

Constructor Summary

Constructors

Constructor and Description
RewardPointCore() Constructor

Method Summary

Modifier and Type	Method and Description
int	addPoints(int customerId, int points, java.lang.String code, java.lang.String description, KKCriteria crit) Adds a number of reward points to the total for customer identified by the sessionId parameter.
protected void	checkRequired(java.lang.Object param, java.lang.String paramType, java.lang.String paramName) Throws an exception with a proper message if the required parameter is null or null or empty for the case of a string.
int	deletePoints(int customerId, int rewardPoints, java.lang.String code, java.lang.String description, KKCriteria crit1, KKCriteria crit2) 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, KKCriteria crit) Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter.
int	freeReservedPoints(int customerId, int reservationId, KKCriteria crit1, KKCriteria crit2) Verifies that the reservationId parameter exists and that it belongs to the customer identified by the sessionId parameter.
int	getReservationId(KKCriteria insertC) Get a unique reservation id from the counter table
int	pointsAvailable(int customerId, KKCriteria crit) Calculates the number of reward points available for the customer identified by the sessionId parameter.
int	reservePoints(int customerId, int rewardPoints, KKCriteria crit1, KKCriteria crit2) Removes a number of reward points from the total for the customer identified by the sessionId parameter.

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

TX_TYPE_ADD_POINTS

public static final int TX_TYPE_ADD_POINTS

Transaction type

See Also:

Constant Field Values

TX_TYPE_REMOVE_POINTS

public static final int TX_TYPE_REMOVE_POINTS

Transaction type

See Also:

Constant Field Values

Constructor Detail

RewardPointCore

public RewardPointCore()
                throws java.lang.Exception

Constructor

Throws:

java.lang.Exception - an unexpected exception

Method Detail

pointsAvailable

public int pointsAvailable(int customerId,
                           KKCriteria crit)
                    throws java.lang.Exception

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

Parameters:

customerId - the customerId

crit - the crit

Returns:

Returns the 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,
                     KKCriteria crit)
              throws java.lang.Exception

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

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

crit - the crit

Returns:

Returns the new number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

deletePoints

public int deletePoints(int customerId,
                        int rewardPoints,
                        java.lang.String code,
                        java.lang.String description,
                        KKCriteria crit1,
                        KKCriteria crit2)
                 throws java.lang.Exception

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

Parameters:

customerId - the customerId

rewardPoints - the rewardPoints

code - the code

description - the description

crit1 - the crit1

crit2 - the crit2

Returns:

Returns the new number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

reservePoints

public int reservePoints(int customerId,
                         int rewardPoints,
                         KKCriteria crit1,
                         KKCriteria crit2)
                  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.

Parameters:

customerId - the customerId

rewardPoints - the rewardPoints

crit1 - the crit1

crit2 - the crit2

Returns:

Returns the reservation id of the reserved points

Throws:

java.lang.Exception - an unexpected exception

deleteReservedPoints

public void deleteReservedPoints(int customerId,
                                 int reservationId,
                                 java.lang.String code,
                                 java.lang.String description,
                                 KKCriteria crit)
                          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.

Parameters:

customerId - the customerId

reservationId - the reservationId

code - the code

description - the description

crit - the crit

Throws:

java.lang.Exception - an unexpected exception

freeReservedPoints

public int freeReservedPoints(int customerId,
                              int reservationId,
                              KKCriteria crit1,
                              KKCriteria crit2)
                       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.

Parameters:

customerId - the customerId

reservationId - the reservationId

crit1 - the crit1

crit2 - the crit2

Returns:

Returns the number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

getReservationId

public int getReservationId(KKCriteria insertC)
                     throws org.apache.torque.TorqueException,
                            com.konakart.app.KKException

Get a unique reservation id from the counter table

Parameters:

insertC - the insertC

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

checkRequired

protected void checkRequired(java.lang.Object param,
                             java.lang.String paramType,
                             java.lang.String paramName)
                      throws com.konakart.app.KKException

Throws an exception with a proper message if the required parameter is null or null or empty for the case of a string.

Parameters:

param - the param

paramType - the paramType

paramName - the paramName

Throws:

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