gi.controlsite.objects

Class CSDiscountUtil

java.lang.Object

gi.controlsite.objects.CSDiscountUtil

public final class CSDiscountUtil
extends java.lang.Object

Utility Class for manipulating discounts.

The CSDiscountUtil class includes methods for evaluating the discount to be applied to a specified product option obtained from a specified rack, and for getting the status of the specified discount.

See Also:

CSDiscountScheme, CSProductOption, CSProductType, CSRack

Field Summary

Fields

Modifier and Type	Field and Description
static int	DiscountQualifyType_NONE
static int	DiscountQualifyType_QUANTITY
static int	DiscountQualifyType_SPEND
static int	DiscountType_BASKET
static int	DiscountType_GROUP1
static int	DiscountType_GROUP2
static int	DiscountType_OPTION
static int	DiscountType_TYPE
static int	DiscountValueType_AMOUNT
static int	DiscountValueType_ITEM
static int	DiscountValueType_PERCENT

Method Summary

Modifier and Type	Method and Description
static CSBasket	evaluateBasketDiscounts(java.sql.Connection con, CSBasket objBasket, java.lang.String strCountryName, int nDecimalPlaces) Evaluates the discounts to be applied to the specified product options in the specified basket.
static CSBasket	evaluateBasketDiscounts(java.lang.String strPropertyFile, CSBasket basket, java.lang.String strCountryName, int nDecimalPlaces) Evaluates the discounts to be applied to the specified product options in the specified basket.
static double	evaluateDiscount(java.sql.Connection con, CSDiscountScheme objDiscountScheme, int nProductOptionID, int nProductTypeID, int nRackID, double nQuantity, int nDecimalPlaces) Evaluates the discount to be applied to a specified product option obtained from a specified rack.
static double	evaluateDiscount(java.lang.String strPropertyFile, CSDiscountScheme objDiscountScheme, int nProductOptionID, int nProductTypeID, int nRackID, double nQuantity, int nDecimalPlaces) Evaluates the discount to be applied to a specified product option obtained from a specified rack.
static java.lang.String	getEvaluatedBasketDiscountsStr(CSBasket objBasket) Gets the status of the discount schemes that have been applied to a basket using evaluateBasketDiscounts.
static boolean	getStatus(java.lang.String strPropertyFile, CSDiscountScheme discountScheme, int productOptionID, int productTypeID, int productGroupID, int rackID) Gets the status of the discount scheme.

Methods inherited from class java.lang.Object

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

Field Detail

DiscountType_OPTION

public static final int DiscountType_OPTION

See Also:

Constant Field Values

DiscountType_TYPE

public static final int DiscountType_TYPE

See Also:

Constant Field Values

DiscountType_GROUP1

public static final int DiscountType_GROUP1

See Also:

Constant Field Values

DiscountType_GROUP2

public static final int DiscountType_GROUP2

See Also:

Constant Field Values

DiscountType_BASKET

public static final int DiscountType_BASKET

See Also:

Constant Field Values

DiscountQualifyType_QUANTITY

public static final int DiscountQualifyType_QUANTITY

See Also:

Constant Field Values

DiscountQualifyType_SPEND

public static final int DiscountQualifyType_SPEND

See Also:

Constant Field Values

DiscountQualifyType_NONE

public static final int DiscountQualifyType_NONE

See Also:

Constant Field Values

DiscountValueType_AMOUNT

public static final int DiscountValueType_AMOUNT

See Also:

Constant Field Values

DiscountValueType_PERCENT

public static final int DiscountValueType_PERCENT

See Also:

Constant Field Values

DiscountValueType_ITEM

public static final int DiscountValueType_ITEM

See Also:

Constant Field Values

Method Detail

evaluateDiscount

public static double evaluateDiscount(java.lang.String strPropertyFile,
                                      CSDiscountScheme objDiscountScheme,
                                      int nProductOptionID,
                                      int nProductTypeID,
                                      int nRackID,
                                      double nQuantity,
                                      int nDecimalPlaces)
                               throws CSException

Evaluates the discount to be applied to a specified product option obtained from a specified rack.

Parameters:

strPropertyFile - the property file that contains the connection details.

objDiscountScheme - the discount scheme.

nProductOptionID - the product option ID.

nProductTypeID - the product type ID.

nRackID - the rack ID.

nQuantity - the quantity.

nDecimalPlaces - the number of decimals places to format the returned discount value with.

Returns:

The value of the evaluated discount

Throws:

CSException - the base class for exceptions thrown by this method.

evaluateDiscount

public static double evaluateDiscount(java.sql.Connection con,
                                      CSDiscountScheme objDiscountScheme,
                                      int nProductOptionID,
                                      int nProductTypeID,
                                      int nRackID,
                                      double nQuantity,
                                      int nDecimalPlaces)
                               throws CSException

Evaluates the discount to be applied to a specified product option obtained from a specified rack.

Parameters:

con - the database connection object instantiated by the framework.

objDiscountScheme - the discount scheme.

nProductOptionID - the product option ID.

nProductTypeID - the product type ID.

nRackID - the rack ID.

nQuantity - the quantity.

nDecimalPlaces - the number of decimals places to format the returned discount value with.

Returns:

The value of the evaluated discount

Throws:

CSException - the base class for exceptions thrown by this method.

getStatus

public static boolean getStatus(java.lang.String strPropertyFile,
                                CSDiscountScheme discountScheme,
                                int productOptionID,
                                int productTypeID,
                                int productGroupID,
                                int rackID)
                         throws CSException

Gets the status of the discount scheme.

Parameters:

strPropertyFile - the property file that contains the connection details.

discountScheme - the discount scheme.

productOptionID - the product option ID.

productTypeID - the product type ID.

productGroupID - the product group ID.

rackID - the rack ID.

Returns:

The status of the discount scheme

Throws:

CSException - the base class for exceptions thrown by this method.

evaluateBasketDiscounts

public static CSBasket evaluateBasketDiscounts(java.lang.String strPropertyFile,
                                               CSBasket basket,
                                               java.lang.String strCountryName,
                                               int nDecimalPlaces)
                                        throws CSException

Evaluates the discounts to be applied to the specified product options in the specified basket.

Parameters:

strPropertyFile - the property file that contains the connection details.

basket - the basket.

strCountryName - the official name of the country used to calculate country VAT, country net price and country gross price.

nDecimalPlaces - the number of decimals places to format the returned discount value with.

Returns:

The updated basket, including a JSON encoded structure added to the BasketItemUserData. The format for this structure is a root element named DiscountInfo with the following enclosed elements: DiscountChain, DiscountApplied, Price, TotalPrice, ItemDescription, BasketItemID. The BasketItemID contains the original BasketItemID. The returned basket has BasketItemIDs of 0, since it has been modified to have a single line per item in the basket.

Throws:

CSException - the base class for exceptions thrown by this method.

evaluateBasketDiscounts

public static CSBasket evaluateBasketDiscounts(java.sql.Connection con,
                                               CSBasket objBasket,
                                               java.lang.String strCountryName,
                                               int nDecimalPlaces)
                                        throws CSException

Evaluates the discounts to be applied to the specified product options in the specified basket.

Parameters:

con - the database connection object instantiated by the framework.

objBasket - the basket.

strCountryName - the official name of the country used to calculate country VAT, country net price and country gross price.

nDecimalPlaces - the number of decimals places to format the returned discount value with.

Returns:

The updated basket, including a JSON encoded structure added to the BasketItemUserData. The format for this structure is a root element named DiscountInfo with the following enclosed elements: DiscountChain, DiscountApplied, Price, TotalPrice, ItemDescription, BasketItemID. The BasketItemID contains the original BasketItemID. The returned basket has BasketItemIDs of 0, since it has been modified to have a single line per item in the basket.

Throws:

CSException - the base class for exceptions thrown by this method.

getEvaluatedBasketDiscountsStr

public static java.lang.String getEvaluatedBasketDiscountsStr(CSBasket objBasket)
                                                       throws CSException

Gets the status of the discount schemes that have been applied to a basket using evaluateBasketDiscounts.

Parameters:

objBasket - the basket.

Returns:

A string representation of the basket contents, including any JSON encoded evaluated discount results.

Throws:

CSException - the base class for exceptions thrown by this method.