com.konakart.al

Class RewardPointMgr

java.lang.Object

com.konakart.al.BaseMgr

com.konakart.al.RewardPointMgr

public class RewardPointMgr
extends BaseMgr

Contains methods to manage Reward Points

Field Summary

Fields inherited from class com.konakart.al.BaseMgr

eng, kkAppEng

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RewardPointMgr(com.konakart.appif.KKEngIf eng, KKAppEng kkAppEng) Constructor

Method Summary

Modifier and Type	Method and Description
int	addPoints(int points, java.lang.String code, java.lang.String description) Adds a number of reward points to the customer's total
int	getCurrentOffset()
int	getCurrentPage()
com.konakart.appif.RewardPointIf[]	getCurrentRewardPoints()
com.konakart.appif.FetchRewardPointOptionsIf	getFetchRewardPointOptions()
int	getMaxRows() Maximum number of reward point transactions to show in a list.
java.lang.String	getNavBack() Static string - navigate backwards.
java.lang.String	getNavNext() Static string - navigate forwards.
java.lang.String	getNavStart() Static string - navigate to the start.
int	getNumberOfRewardPoints() Returns the number of reward point records currently retrieved.
int	getNumPages()
java.util.ArrayList<java.lang.Integer>	getPageList()
void	getRewardPoints() It gets an array of reward point transactions
int	getShowBack() Show the back button if set to 1.
int	getShowNext() Show the next button if set to 1.
int	getTotalNumberOfRewardPoints()
boolean	isEnabled() Based on a configuration variable decides whether reward points are enabled.
void	navigateCurrentRewardPoints(java.lang.String navDir) This method is called to navigate through a list of reward point records when the list is longer than maxRows. navDir can take the following values which are retrieved using getter methods on the RewardPointMgr instance: getNavNext() getNavBack() getNavStart()
int	pointsAvailable() Returns the number of reward points available to the customer.
void	refreshConfigs() Refresh the configuration variables.
void	reset() Puts the RewardPointMgr object back into it's original state
void	setCurrentPage(int currentPage)
void	setNumPages(int numPages)

Methods inherited from class com.konakart.al.BaseMgr

getEng, getKkAppEng, getPages, isMgrReady, setEng, setKkAppEng

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RewardPointMgr

protected RewardPointMgr(com.konakart.appif.KKEngIf eng,
                         KKAppEng kkAppEng)
                  throws com.konakart.app.KKException

Constructor

Parameters:

eng - the eng

kkAppEng - the kkAppEng

Throws:

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

Method Detail

reset

public void reset()
           throws com.konakart.app.KKException

Puts the RewardPointMgr object back into it's original state

Throws:

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

pointsAvailable

public int pointsAvailable()
                    throws com.konakart.app.KKException,
                           KKAppException

Returns the number of reward points available to the customer. Uses a cached version if subsequent calls are in close succession.

Returns:

Returns the number of reward points available to the customer

Throws:

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

KKAppException - an unexpected KKAppException exception

addPoints

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

Adds a number of reward points to the customer's total

Parameters:

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

refreshConfigs

public void refreshConfigs()
                    throws com.konakart.app.KKException

Refresh the configuration variables. This is called automatically at a regular interval.

Throws:

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

navigateCurrentRewardPoints

public void navigateCurrentRewardPoints(java.lang.String navDir)
                                 throws com.konakart.app.KKException,
                                        KKAppException

This method is called to navigate through a list of reward point records when the list is longer than maxRows.
navDir can take the following values which are retrieved using getter methods on the RewardPointMgr instance:

• getNavNext()
• getNavBack()
• getNavStart()

Parameters:

navDir - The navigation direction

Throws:

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

KKAppException - an unexpected KKAppException exception

getRewardPoints

public void getRewardPoints()
                     throws com.konakart.app.KKException,
                            KKAppException

It gets an array of reward point transactions

Throws:

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

KKAppException - an unexpected KKAppException exception

getNumberOfRewardPoints

public int getNumberOfRewardPoints()

Returns the number of reward point records currently retrieved.

Returns:

Returns the number of reward point records currently retrieved.

getCurrentOffset

public int getCurrentOffset()

Returns:

the currentOffset

isEnabled

public boolean isEnabled()
                  throws KKAppException

Based on a configuration variable decides whether reward points are enabled. It returns true if they are enabled. Otherwise it returns false.

Returns:

Returns true if reward points are enabled

Throws:

KKAppException - an unexpected KKAppException exception

getNavBack

public java.lang.String getNavBack()

Static string - navigate backwards. It is the string required to pass to the navigateCurrentRewardPoints() as the navdir attribute when navigating backwards.

Returns:

Returns the navBack.

getNavNext

public java.lang.String getNavNext()

Static string - navigate forwards. It is the string required to pass to the navigateCurrentRewardPoints() as the navdir attribute when navigating forwards.

Returns:

Returns the navNext.

getNavStart

public java.lang.String getNavStart()

Static string - navigate to the start. It is the string required to pass to the navigateCurrentRewardPoints() as the navdir attribute when navigating to the start.

Returns:

Returns the navStart.

getShowBack

public int getShowBack()

Show the back button if set to 1. Don't show the back button if set to 0.

Returns:

Returns the showBack.

getShowNext

public int getShowNext()

Show the next button if set to 1. Don't show the next button if set to 0.

Returns:

Returns the showNext.

getNumPages

public int getNumPages()

Returns:

the numPages

setNumPages

public void setNumPages(int numPages)

Parameters:

numPages - the numPages to set

getTotalNumberOfRewardPoints

public int getTotalNumberOfRewardPoints()

Returns:

the totalNumberOfRewardPoints

getMaxRows

public int getMaxRows()

Maximum number of reward point transactions to show in a list.

Returns:

Returns the maxRows.

getCurrentRewardPoints

public com.konakart.appif.RewardPointIf[] getCurrentRewardPoints()

Returns:

the currentRewardPoints

getCurrentPage

public int getCurrentPage()

Returns:

the currentPage

setCurrentPage

public void setCurrentPage(int currentPage)

Parameters:

currentPage - the currentPage to set

getPageList

public java.util.ArrayList<java.lang.Integer> getPageList()

Returns:

the pageList

getFetchRewardPointOptions

public com.konakart.appif.FetchRewardPointOptionsIf getFetchRewardPointOptions()

Returns:

Returns the standard FetchRewardPointOptions