RewardPointIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

RewardPoint
```
public interface RewardPointIf
```
Describes a reward points object for use within KonaKart.

Method Summary

All Methods Instance Methods Abstract Methods
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.

- Method Detail
  - getId
```
int getId()
```
    The numeric id of the Reward Points Object
    
    Returns:
    
    the id
  - setId
```
void setId(int id)
```
    The numeric id of the Reward Points Object
    
    Parameters:
    
    id - the id to set
  - getStoreId
```
java.lang.String getStoreId()
```
    The store id
    
    Returns:
    
    the storeId
  - setStoreId
```
void setStoreId(java.lang.String storeId)
```
    The store id
    
    Parameters:
    
    storeId - the storeId to set
  - getCode
```
java.lang.String getCode()
```
    A code used to define the type of transaction in which the points were added or removed. i.e. ORDER, REVIEW, REGISTRATION
    
    Returns:
    
    the code
  - setCode
```
void setCode(java.lang.String code)
```
    A code used to define the type of transaction in which the points were added or removed. i.e. ORDER, REVIEW, REGISTRATION
    
    Parameters:
    
    code - the code to set
  - getDescription
```
java.lang.String getDescription()
```
    A description that can be viewed in a points statement. i.e. Points redeemed in order with id = 123
    
    Returns:
    
    the description
  - setDescription
```
void setDescription(java.lang.String description)
```
    A description that can be viewed in a points statement. i.e. Points redeemed in order with id = 123
    
    Parameters:
    
    description - the description to set
  - getCustomerId
```
int getCustomerId()
```
    The numeric id of the customer that the points belong to.
    
    Returns:
    
    the customerId
  - setCustomerId
```
void setCustomerId(int customerId)
```
    The numeric id of the customer that the points belong to.
    
    Parameters:
    
    customerId - the customerId to set
  - getInitialPoints
```
int getInitialPoints()
```
    The initial number of points when they were awarded
    
    Returns:
    
    the initialPoints
  - setInitialPoints
```
void setInitialPoints(int initialPoints)
```
    The initial number of points when they were awarded
    
    Parameters:
    
    initialPoints - the initialPoints to set
  - getRemainingPoints
```
int getRemainingPoints()
```
    The number of points remaining, since some may have been used.
    
    Returns:
    
    the remainingPoints
  - setRemainingPoints
```
void setRemainingPoints(int remainingPoints)
```
    The number of points remaining, since some may have been used.
    
    Parameters:
    
    remainingPoints - the remainingPoints to set
  - isExpired
```
boolean isExpired()
```
    Indicates whether the points have expired
    
    Returns:
    
    the expired
  - setExpired
```
void setExpired(boolean expired)
```
    Indicates whether the points have expired
    
    Parameters:
    
    expired - the expired to set
  - getTransactionType
```
int getTransactionType()
```
    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
    Returns:
    
    the transactionType
  - setTransactionType
```
void setTransactionType(int transactionType)
```
    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
    Parameters:
    
    transactionType - the transactionType to set
  - getDateAdded
```
java.util.Calendar getDateAdded()
```
    The date added
    
    Returns:
    
    the dateAdded
  - setDateAdded
```
void setDateAdded(java.util.Calendar dateAdded)
```
    The date added
    
    Parameters:
    
    dateAdded - the dateAdded to set

Interface RewardPointIf

Method Summary

Method Detail

getId

setId

getStoreId

setStoreId

getCode

setCode

getDescription

setDescription

getCustomerId

setCustomerId

getInitialPoints

setInitialPoints

getRemainingPoints

setRemainingPoints

isExpired

setExpired

getTransactionType

setTransactionType

getDateAdded

setDateAdded