atg.commerce.pricing

Class AggregatorInfo

java.lang.Object

atg.commerce.pricing.AggregatorInfo

public class AggregatorInfo
extends java.lang.Object

Bean class used to hold aggregated 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
AggregatorInfo(java.lang.Double pAggregatedValue, java.lang.Long pQuantityMatched) Default constructor.
AggregatorInfo(java.lang.Double pAggregatedValue, java.lang.Long pQuantityMatched, java.lang.Double pQuantityWithFractionMatched) Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getAggregatedValue() Getter for the operations property, which is the list of operations that this aggregator supports.
java.lang.Long	getQuantityMatched() Getter for the operations property, which is the list of operations that this aggregator supports.
double	getQuantityMatchedDerivedAsFloatingPoint() This method will return a derived quantity value.
double	getQuantityWithFractionMatched() Getter for the quantity of the item that matched
boolean	isFractional() If getQuantityWithFraction is greater that 0.0, item is fractional.
void	setAggregatedValue(java.lang.Double pAggregatedValue) Setter for the AggregatedValue property.
void	setQuantityMatched(java.lang.Long pQuantityMatched) Setter for the aggregators property.
void	setQuantityWithFractionMatched(double pQuantityWithFractionMatched) Setter for the quantity matched of the item

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

AggregatorInfo

public AggregatorInfo(java.lang.Double pAggregatedValue,
                      java.lang.Long pQuantityMatched)

Default constructor.

Parameters:

pAggregatedValue - the aggregated value so far

pQuantityMatched - the quantity that matched

AggregatorInfo

public AggregatorInfo(java.lang.Double pAggregatedValue,
                      java.lang.Long pQuantityMatched,
                      java.lang.Double pQuantityWithFractionMatched)

Default constructor.

Parameters:

pAggregatedValue - the aggregated value so far

pQuantityMatched - the quantity that matched

pQuantityWithFractionMatched - the quantity that matched. This value will take precedence over pQuantityMatched if non-null value passed.

Method Detail

setAggregatedValue

public void setAggregatedValue(java.lang.Double pAggregatedValue)

Setter for the AggregatedValue property.

Parameters:

pAggregatedValue - aggregated value

getAggregatedValue

public java.lang.Double getAggregatedValue()

Getter for the operations property, which is the list of operations that this aggregator supports.

Returns:

the aggregated value

setQuantityMatched

public void setQuantityMatched(java.lang.Long pQuantityMatched)

Setter for the aggregators property.

Parameters:

pQuantityMatched - map of aggregators

getQuantityMatched

public java.lang.Long getQuantityMatched()

Getter for the operations property, which is the list of operations that this aggregator supports.

Returns:

a map of aggregators

setQuantityWithFractionMatched

public void setQuantityWithFractionMatched(double pQuantityWithFractionMatched)

Setter for the quantity matched of the item

Parameters:

pQuantityWithFractionMatched - quantity matched of the item

getQuantityWithFractionMatched

public double getQuantityWithFractionMatched()

Getter for the quantity of the item that matched

Returns:

quantity of the item that matched

getQuantityMatchedDerivedAsFloatingPoint

public double getQuantityMatchedDerivedAsFloatingPoint()

This method will return a derived quantity value.

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:

a derived quantity value

isFractional

public boolean isFractional()

If getQuantityWithFraction is greater that 0.0, item is fractional.

Returns:

boolean flag indicating whether item is fractional or not.