com.konakart.app

Class RewardPoint

java.lang.Object

com.konakart.app.RewardPoint

All Implemented Interfaces:

RewardPointIf

public class RewardPoint
extends java.lang.Object
implements RewardPointIf

A reward points object for use within KonaKart.

Constructor Summary

Constructors

Constructor and Description
RewardPoint() Constructor
RewardPoint(com.workingdogs.village.Record vr, KKCriteria c) Instantiates the attributes of the Reward Points object from a Record object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() A code used to define the type of transaction in which the points were added or removed.
int	getCustomerId() The numeric id of the customer that the points belong to.
java.util.Calendar	getDateAdded() The date added
java.lang.String	getDescription() A description that can be viewed in a points statement.
int	getId() The numeric id of the Reward Points Object
int	getInitialPoints() The initial number of points when they were awarded
int	getRemainingPoints() The number of points remaining, since some may have been used.
java.lang.String	getStoreId() The store id
int	getTransactionType() The type of transaction which indicates whether the points have been added or removed.
boolean	isExpired() Indicates whether the points have expired
void	setCode(java.lang.String code) A code used to define the type of transaction in which the points were added or removed.
void	setCustomerId(int customerId) The numeric id of the customer that the points belong to.
void	setDateAdded(java.util.Calendar dateAdded) The date added
void	setDescription(java.lang.String description) A description that can be viewed in a points statement.
void	setExpired(boolean expired) Indicates whether the points have expired
void	setId(int id) The numeric id of the Reward Points Object
void	setInitialPoints(int initialPoints) The initial number of points when they were awarded
void	setRemainingPoints(int remainingPoints) The number of points remaining, since some may have been used.
void	setStoreId(java.lang.String storeId) The store id
void	setTransactionType(int transactionType) The type of transaction which indicates whether the points have been added or removed.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RewardPoint

public RewardPoint()

Constructor

RewardPoint

public RewardPoint(com.workingdogs.village.Record vr,
                   KKCriteria c)
            throws com.workingdogs.village.DataSetException

Instantiates the attributes of the Reward Points object from a Record object

Parameters:

vr - Record containing data

c - Criteria containing column names

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the Reward Points object

getId

public int getId()

Description copied from interface: RewardPointIf

The numeric id of the Reward Points Object

Specified by:

getId in interface RewardPointIf

Returns:

the id

setId

public void setId(int id)

Description copied from interface: RewardPointIf

The numeric id of the Reward Points Object

Specified by:

setId in interface RewardPointIf

Parameters:

id - the id to set

getStoreId

public java.lang.String getStoreId()

Description copied from interface: RewardPointIf

The store id

Specified by:

getStoreId in interface RewardPointIf

Returns:

the storeId

setStoreId

public void setStoreId(java.lang.String storeId)

Description copied from interface: RewardPointIf

The store id

Specified by:

setStoreId in interface RewardPointIf

Parameters:

storeId - the storeId to set

getCode

public java.lang.String getCode()

Description copied from interface: RewardPointIf

A code used to define the type of transaction in which the points were added or removed. i.e. ORDER, REVIEW, REGISTRATION

Specified by:

getCode in interface RewardPointIf

Returns:

the code

setCode

public void setCode(java.lang.String code)

Description copied from interface: RewardPointIf

A code used to define the type of transaction in which the points were added or removed. i.e. ORDER, REVIEW, REGISTRATION

Specified by:

setCode in interface RewardPointIf

Parameters:

code - the code to set

getDescription

public java.lang.String getDescription()

Description copied from interface: RewardPointIf

A description that can be viewed in a points statement. i.e. Points redeemed in order with id = 123

Specified by:

getDescription in interface RewardPointIf

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: RewardPointIf

A description that can be viewed in a points statement. i.e. Points redeemed in order with id = 123

Specified by:

setDescription in interface RewardPointIf

Parameters:

description - the description to set

getCustomerId

public int getCustomerId()

Description copied from interface: RewardPointIf

The numeric id of the customer that the points belong to.

Specified by:

getCustomerId in interface RewardPointIf

Returns:

the customerId

setCustomerId

public void setCustomerId(int customerId)

Description copied from interface: RewardPointIf

The numeric id of the customer that the points belong to.

Specified by:

setCustomerId in interface RewardPointIf

Parameters:

customerId - the customerId to set

getInitialPoints

public int getInitialPoints()

Description copied from interface: RewardPointIf

The initial number of points when they were awarded

Specified by:

getInitialPoints in interface RewardPointIf

Returns:

the initialPoints

setInitialPoints

public void setInitialPoints(int initialPoints)

Description copied from interface: RewardPointIf

The initial number of points when they were awarded

Specified by:

setInitialPoints in interface RewardPointIf

Parameters:

initialPoints - the initialPoints to set

getRemainingPoints

public int getRemainingPoints()

Description copied from interface: RewardPointIf

The number of points remaining, since some may have been used.

Specified by:

getRemainingPoints in interface RewardPointIf

Returns:

the remainingPoints

setRemainingPoints

public void setRemainingPoints(int remainingPoints)

Description copied from interface: RewardPointIf

The number of points remaining, since some may have been used.

Specified by:

setRemainingPoints in interface RewardPointIf

Parameters:

remainingPoints - the remainingPoints to set

isExpired

public boolean isExpired()

Description copied from interface: RewardPointIf

Indicates whether the points have expired

Specified by:

isExpired in interface RewardPointIf

Returns:

the expired

setExpired

public void setExpired(boolean expired)

Description copied from interface: RewardPointIf

Indicates whether the points have expired

Specified by:

setExpired in interface RewardPointIf

Parameters:

expired - the expired to set

getTransactionType

public int getTransactionType()

Description copied from interface: RewardPointIf

The type of transaction which indicates whether the points have been added or removed. Valid values are:

• com.konakart.bl.RewardPointCore.TX_TYPE_ADD_POINTS
• com.konakart.bl.RewardPointCore.TX_TYPE_REMOVE_POINTS

Specified by:

getTransactionType in interface RewardPointIf

Returns:

the transactionType

setTransactionType

public void setTransactionType(int transactionType)

Description copied from interface: RewardPointIf

The type of transaction which indicates whether the points have been added or removed. Valid values are:

• com.konakart.bl.RewardPointCore.TX_TYPE_ADD_POINTS
• com.konakart.bl.RewardPointCore.TX_TYPE_REMOVE_POINTS

Specified by:

setTransactionType in interface RewardPointIf

Parameters:

transactionType - the transactionType to set

getDateAdded

public java.util.Calendar getDateAdded()

Description copied from interface: RewardPointIf

The date added

Specified by:

getDateAdded in interface RewardPointIf

Returns:

the dateAdded

setDateAdded

public void setDateAdded(java.util.Calendar dateAdded)

Description copied from interface: RewardPointIf

The date added

Specified by:

setDateAdded in interface RewardPointIf

Parameters:

dateAdded - the dateAdded to set