atg.commerce.pricing.definition

Class MatchingObject

java.lang.Object

atg.commerce.pricing.definition.MatchingObject

public class MatchingObject
extends java.lang.Object

An element of a collection that matched, the quantity that matched and any associated discount information.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
MatchingObject(java.lang.Object pMatchingObject, long pQuantity) Constructor to add a matched Object and quantity.
MatchingObject(java.lang.Object pMatchingObject, long pQuantity, double pQuantityWithFraction) Constructor to add a matched Object and quantity (with fraction).

Method Summary

Methods

Modifier and Type	Method and Description
void	addDiscount(DiscountStructure pDiscount) Utility method to add another discount to the list of discounts.
java.util.List<DiscountStructure>	getDiscounts() Get property Discounts.
java.util.Map<java.lang.Integer,java.lang.Long>	getGroupIndexQuantityMap() Get property IndexQuantityMap
java.util.Map<java.lang.Integer,java.lang.Double>	getGroupIndexQuantityWithFractionMap() Get property IndexQuantityWithFractionMap
java.util.Map<java.lang.Integer,java.lang.Long>	getIteratorIndexMap() Get property IteratorIndexMap
java.util.Map<java.lang.Integer,java.lang.Double>	getIteratorIndexQuantityWithFractionMap() Get property IteratorIndexQuantityWithFractionMap
java.lang.Object	getMatchingObject() Get property MatchingObject The object that matched, typically a FilteredCommerceItem
long	getQuantity() Get property Quantity The quantity of the object that matched
double	getQuantityDerivedAsFloatingPoint() This method will return a derived quantity value which this object represents.
double	getQuantityWithFraction() Returns the quantity with fraction to add for a new commerce item
boolean	isFractional() If getQuantityWithFraction is greater that 0.0, item is fractional.
void	setDiscounts(java.util.List<DiscountStructure> pDiscounts) Set property Discounts The List of discount structure of the object that matched
void	setGroupIndexQuantityMap(java.util.Map<java.lang.Integer,java.lang.Long> pGroupIndexQuantityMap) Set property IndexQuantityMap
void	setGroupIndexQuantityWithFractionMap(java.util.Map<java.lang.Integer,java.lang.Double> pGroupIndexQuantityWithFractionMap) Set property IndexQuantityWithFractionMap
void	setIteratorIndexMap(int pIteratorIndex, long pMatchingQuantity) Set property IteratorIndexMap
void	setIteratorIndexQuantityWithFractionMap(int pIteratorIndex, double pMatchingQuantityWithFraction) Set property IteratorIndexQuantityWithFractionMap
void	setMatchingObject(java.lang.Object pMatchingObject) Set property MatchingObject The object that matched, typically a FilteredCommerceItem
void	setQuantity(long pQuantity) Set property Quantity The quantity of the object that matched
void	setQuantityWithFraction(double pQuantityWithFraction) Sets the quantity with fraction to add for a new commerce item
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

MatchingObject

public MatchingObject(java.lang.Object pMatchingObject,
              long pQuantity)

Constructor to add a matched Object and quantity.

Parameters:

pMatchingObject - Object that matched

pQuantity - long quantity

MatchingObject

public MatchingObject(java.lang.Object pMatchingObject,
              long pQuantity,
              double pQuantityWithFraction)

Constructor to add a matched Object and quantity (with fraction).

Parameters:

pMatchingObject - Object that matched

pQuantity - long quantity

pQuantityWithFraction - double quantity (with fraction)

Method Detail

setMatchingObject

public void setMatchingObject(java.lang.Object pMatchingObject)

Set property MatchingObject
The object that matched, typically a FilteredCommerceItem

Parameters:

pMatchingObject - new Object value to set

getMatchingObject

public java.lang.Object getMatchingObject()

Get property MatchingObject
The object that matched, typically a FilteredCommerceItem

Returns:

Object that matched

setQuantity

public void setQuantity(long pQuantity)

Set property Quantity
The quantity of the object that matched

Parameters:

pQuantity - long new quantity to set

getQuantity

public long getQuantity()

Get property Quantity
The quantity of the object that matched

Returns:

Quantity long

setQuantityWithFraction

public void setQuantityWithFraction(double pQuantityWithFraction)

Sets the quantity with fraction to add for a new commerce item

Parameters:

pQuantityWithFraction - represents the fractional quantity.

getQuantityWithFraction

public double getQuantityWithFraction()

Returns the quantity with fraction to add for a new commerce item

Returns:

mQuantityWithFraction a double value.

getQuantityDerivedAsFloatingPoint

public double getQuantityDerivedAsFloatingPoint()

This method will return a derived quantity value which this object represents.

It will decide upon the correct quantity value to return, returning the first non zero value from the properties, quantityWithFraction, quantity, in that order.

The method should be used where there is a need to know the quantity of an item but it is unknown to the caller as to which property (quantityWithFraction or quantity holds the value.

Returns:

quantity matching

isFractional

public boolean isFractional()

If getQuantityWithFraction is greater that 0.0, item is fractional.

Returns:

boolean flag indicating whether item is fractional or not.

setDiscounts

public void setDiscounts(java.util.List<DiscountStructure> pDiscounts)

Set property Discounts
The List of discount structure of the object that matched

Parameters:

pDiscounts - new DiscountStructure List to set

getDiscounts

public java.util.List<DiscountStructure> getDiscounts()

Get property Discounts.
The List of DiscountStructure of the object that matched

Returns:

List of DiscountStructure

setIteratorIndexMap

public void setIteratorIndexMap(int pIteratorIndex,
                       long pMatchingQuantity)

Set property IteratorIndexMap

Parameters:

pIteratorIndex - the index of the iterator that this object matched in

pMatchingQuantity - the matching quantity found for the given iterator

getIteratorIndexMap

public java.util.Map<java.lang.Integer,java.lang.Long> getIteratorIndexMap()

Get property IteratorIndexMap

Returns:

a map holding the matching iterator index (key) and the matching quantity (value)

setIteratorIndexQuantityWithFractionMap

public void setIteratorIndexQuantityWithFractionMap(int pIteratorIndex,
                                           double pMatchingQuantityWithFraction)

Set property IteratorIndexQuantityWithFractionMap

Parameters:

pIteratorIndex - the index of the iterator that this object matched in

pMatchingQuantityWithFraction - the matching quantity found for the given iterator

getIteratorIndexQuantityWithFractionMap

public java.util.Map<java.lang.Integer,java.lang.Double> getIteratorIndexQuantityWithFractionMap()

Get property IteratorIndexQuantityWithFractionMap

Returns:

a map holding the matching iterator index (key) and the matching quantity (value)

getGroupIndexQuantityMap

public java.util.Map<java.lang.Integer,java.lang.Long> getGroupIndexQuantityMap()

Get property IndexQuantityMap

Returns:

a map associating quantities from this matching object with discount groups.

setGroupIndexQuantityMap

public void setGroupIndexQuantityMap(java.util.Map<java.lang.Integer,java.lang.Long> pGroupIndexQuantityMap)

Set property IndexQuantityMap

Parameters:

pGroupIndexQuantityMap - - a map associating quantities from this matching object with discount groups.

getGroupIndexQuantityWithFractionMap

public java.util.Map<java.lang.Integer,java.lang.Double> getGroupIndexQuantityWithFractionMap()

Get property IndexQuantityWithFractionMap

Returns:

a map associating quantities from this matching object with discount groups.

setGroupIndexQuantityWithFractionMap

public void setGroupIndexQuantityWithFractionMap(java.util.Map<java.lang.Integer,java.lang.Double> pGroupIndexQuantityWithFractionMap)

Set property IndexQuantityWithFractionMap

Parameters:

pGroupIndexQuantityWithFractionMap - - a map associating quantities from this matching object with discount groups.

addDiscount

public void addDiscount(DiscountStructure pDiscount)

Utility method to add another discount to the list of discounts.

Parameters:

pDiscount - DiscountStructure to add

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object