com.konakart.blif

Interface RewardPointMgrIf

All Known Implementing Classes:

RewardPointMgr

public interface RewardPointMgrIf

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

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

Method Detail

pointsAvailable

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.

Parameters:

sessionId - the sessionId

Returns:

Returns the number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

pointsAvailable

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

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

Parameters:

customerId - the customerId

Returns:

Returns the number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

addPoints

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.

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

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.

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

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.

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

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.

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

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.

Parameters:

sessionId - the sessionId

points - the points

Returns:

Returns the reservation id of the reserved points

Throws:

java.lang.Exception - an unexpected exception

reservePoints

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.

Parameters:

customerId - the customerId

points - the points

Returns:

Returns the reservation id of the reserved points

Throws:

java.lang.Exception - an unexpected exception

deleteReservedPoints

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.

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

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.

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

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.

Parameters:

sessionId - the sessionId

reservationId - the reservationId

Returns:

Returns the number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

freeReservedPoints

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.

Parameters:

customerId - the customerId

reservationId - the reservationId

Returns:

Returns the number of points available for spending

Throws:

java.lang.Exception - an unexpected exception

getRewardPointsWithOptions

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.

Parameters:

sessionId - the sessionId

dataDescriptor - the dataDescriptor

options - Allows you to define whether to return expired points

Returns:

Returns a RewardPoints object

Throws:

java.lang.Exception - an unexpected exception

getRewardPoints

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.

Parameters:

sessionId - the sessionId

dataDesc - the dataDesc

Returns:

Returns a RewardPoints object

Throws:

java.lang.Exception - an unexpected exception