GWPInfo (ATG Java API)

java.lang.Object
- atg.commerce.pricing.GWPInfo

```
public class GWPInfo
extends java.lang.Object
```
Contains information on the state of a GWP promotion. There will be an instance of this class for each GWP promotion that qualifies and free gift selection given.
e.g. if a promotion gives away 1 shirt and 3 item in a GWP category then there would be two GWPInfo objects.
There is a 1-1 mapping between GWPInfo objects and the order markers that will be created to store information against the order.
If a GWP promotion applies a discount more than once or qualifies more than once then there is still only a single instance however the quantity is incremented instead.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`protected int`	`mGiftHashCode`
`protected RepositoryItem`	`mMarker`
`protected java.util.Map`	`mOrderDetailsMap`
`protected java.lang.String`	`mPromotionId`
`protected long`	`mQuantity`
`protected double`	`mQuantityWithFraction`
`protected java.util.Map<java.lang.String,java.lang.Long>`	`mTargetedItemsMap`
`protected java.util.Map<java.lang.String,java.lang.Double>`	`mTargetedItemsWithFractionMap`
`protected long`	`mTargetedQuantity`
`protected double`	`mTargetedQuantityWithFraction`

Constructor Summary

Constructors
Constructor and Description
`GWPInfo(java.lang.String pPromotionId, DiscountDetail pDiscountDetail, int pOfferCount)` Constructor uses the discount detail from the GWP promotion to set the properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getGiftHashCode()` Getter for the hash code of the discount detail PMDL that applies to this gift selection.
`java.util.UUID`	`getLastTargetSetUUID()` Get property LastTargetSetUUID
`RepositoryItem`	`getMarker()` Getter for the existing order marker related to this info (if any)
`java.util.Map`	`getOrderDetailsMap()` Getter for the map of other order marker properties.
`java.lang.String`	`getPromotionId()` Getter for the promotion id for this GWPInfo
`long`	`getQuantity()` Getter for the total free quantity this gift selection offers.
`double`	`getQuantityDerivedAsFloatingPoint()` This method will return a derived quantity value which this object represents.
`double`	`getQuantityWithFraction()` Getter for the total free quantity this gift selection offers.
`java.util.Map<QualifiedItem,java.lang.Integer>`	`getTargetableItems()`
`java.util.Map<java.lang.String,java.lang.Long>`	`getTargetedItemsMap()` Getter for the map of commerce item id to quantity targeted to be free.
`java.util.Map<java.lang.String,java.lang.Double>`	`getTargetedItemsWithFractionMap()` Getter for the map of commerce item id to quantity targeted to be free.
`long`	`getTargetedQuantity()` Getter for the total targeted quantity for this gift selection, should add up to the sum of all quantities in the targetedItemsMap.
`double`	`getTargetedQuantityDerivedAsFloatingPoint()` This method will return a derived quantity value which this object represents.
`double`	`getTargetedQuantityWithFraction()` Getter for the total targeted quantity for this gift selection, should add up to the sum of all quantities in the targetedItemsMap.
`void`	`increaseQuantity(DiscountDetail pDiscountDetail, int pOfferCount)` Method to increase the quantity by the amount in the given discount detail
`void`	`merge(GWPInfo pGWPInfo)` Merge the given GWPInfo with this one.
`void`	`setGiftHashCode(int pGiftHashCode)` Setter for the hash code of the discount detail PMDL that applies to this gift selection.
`void`	`setLastTargetSetUUID(java.util.UUID pLastTargetSetUUID)` Set property LastTargetSetUUID.
`void`	`setMarker(RepositoryItem pMarker)` Setter for the existing order marker related to this info (if any)
`void`	`setOrderDetailsMap(java.util.Map pOrderDetailsMap)` Setter for the map of other order marker properties.
`void`	`setPromotionId(java.lang.String pPromotionId)` Setter for the promotion id for this GWPInfo
`void`	`setQuantity(long pQuantity)` Setter for the total free quantity this gift selection offers.
`void`	`setQuantityWithFraction(double pQuantityWithFraction)` Setter for the total free quantity this gift selection offers.
`void`	`setTargetableItems(java.util.Map<QualifiedItem,java.lang.Integer> pTargetableItems)`
`void`	`setTargetedItemsMap(java.util.Map<java.lang.String,java.lang.Long> pTargetedItemsMap)` Setter for the map of commerce item id to quantity targeted to be free.
`void`	`setTargetedItemsWithFractionMap(java.util.Map<java.lang.String,java.lang.Double> pTargetedItemsWithFractionMap)` Setter for the map of commerce item id to quantity targeted to be free.
`void`	`setTargetedQuantity(long pTargetedQuantity)` Setter for the total targeted quantity for this gift selection, should add up to the sum of all quantities in the targetedItemsMap.
`void`	`setTargetedQuantityWithFraction(double pTargetedQuantityWithFraction)` Setter for the total targeted quantity for this gift selection, should add up to the sum of all quantities in the targetedItemsMap.
`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
  - mPromotionId
```
protected java.lang.String mPromotionId
```
  - mGiftHashCode
```
protected int mGiftHashCode
```
  - mQuantity
```
protected long mQuantity
```
  - mQuantityWithFraction
```
protected double mQuantityWithFraction
```
  - mTargetedQuantity
```
protected long mTargetedQuantity
```
  - mTargetedQuantityWithFraction
```
protected double mTargetedQuantityWithFraction
```
  - mOrderDetailsMap
```
protected java.util.Map mOrderDetailsMap
```
  - mTargetedItemsMap
```
protected java.util.Map<java.lang.String,java.lang.Long> mTargetedItemsMap
```
  - mTargetedItemsWithFractionMap
```
protected java.util.Map<java.lang.String,java.lang.Double> mTargetedItemsWithFractionMap
```
  - mMarker
```
protected RepositoryItem mMarker
```
- Constructor Detail
  - GWPInfo
```
public GWPInfo(java.lang.String pPromotionId,
               DiscountDetail pDiscountDetail,
               int pOfferCount)
        throws PricingException
```
    Constructor uses the discount detail from the GWP promotion to set the properties.
    
    Parameters:
    
    pPromotionId - String promotion id for this GWPInfo
    
    pDiscountDetail - GWP promotion discount detail for this gift
    
    pOfferCount - int number of times this discount applied
    
    Throws:
    
    PricingException - if the parameters are not valid
- Method Detail
  - getPromotionId
```
public java.lang.String getPromotionId()
```
    Getter for the promotion id for this GWPInfo
    
    Returns:
    
    String promotion repository id
  - setPromotionId
```
public void setPromotionId(java.lang.String pPromotionId)
```
    Setter for the promotion id for this GWPInfo
    
    Parameters:
    
    pPromotionId - String promotion repository id
  - getGiftHashCode
```
public int getGiftHashCode()
```
    Getter for the hash code of the discount detail PMDL that applies to this gift selection.
    
    Returns:
    
    int hash code
  - setGiftHashCode
```
public void setGiftHashCode(int pGiftHashCode)
```
    Setter for the hash code of the discount detail PMDL that applies to this gift selection.
    
    Parameters:
    
    pGiftHashCode - int hash code
  - getQuantity
```
public long getQuantity()
```
    Getter for the total free quantity this gift selection offers.
    
    Returns:
    
    long quantity
  - setQuantity
```
public void setQuantity(long pQuantity)
```
    Setter for the total free quantity this gift selection offers.
    
    Parameters:
    
    pQuantity - long quantity
  - getQuantityWithFraction
```
public double getQuantityWithFraction()
```
    Getter for the total free quantity this gift selection offers.
    
    Returns:
    
    long quantity
  - setQuantityWithFraction
```
public void setQuantityWithFraction(double pQuantityWithFraction)
```
    Setter for the total free quantity this gift selection offers.
    
    Parameters:
    
    pQuantityWithFraction - double quantity
  - 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 but it is unknown (or not important) to the caller as to which property (quantityWithFraction or quantity holds the value.
    
    Returns:
    
    a derived quantity value
  - getTargetedQuantity
```
public long getTargetedQuantity()
```
    Getter for the total targeted quantity for this gift selection, should add up to the sum of all quantities in the targetedItemsMap.
    
    Returns:
    
    long quantity
  - setTargetedQuantity
```
public void setTargetedQuantity(long pTargetedQuantity)
```
    Setter for the total targeted quantity for this gift selection, should add up to the sum of all quantities in the targetedItemsMap.
    
    Parameters:
    
    pTargetedQuantity - long quantity
  - getTargetedQuantityWithFraction
```
public double getTargetedQuantityWithFraction()
```
    Getter for the total targeted quantity for this gift selection, should add up to the sum of all quantities in the targetedItemsMap.
    
    Returns:
    
    double quantity
  - setTargetedQuantityWithFraction
```
public void setTargetedQuantityWithFraction(double pTargetedQuantityWithFraction)
```
    Setter for the total targeted quantity for this gift selection, should add up to the sum of all quantities in the targetedItemsMap.
    
    Parameters:
    
    pTargetedQuantityWithFraction - long quantity
  - getTargetedQuantityDerivedAsFloatingPoint
```
public double getTargetedQuantityDerivedAsFloatingPoint()
```
    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, targetedQuantityWithFraction, targetedQuantity, in that order.
    The method should be used where there is a need to know the quantity but it is unknown (or not important) to the caller as to which property (quantityWithFraction or quantity holds the value.
    
    Returns:
    
    a derived quantity value
  - getOrderDetailsMap
```
public java.util.Map getOrderDetailsMap()
```
    Getter for the map of other order marker properties.
    
    Returns:
    
    Map
  - setOrderDetailsMap
```
public void setOrderDetailsMap(java.util.Map pOrderDetailsMap)
```
    Setter for the map of other order marker properties.
    
    Parameters:
    
    pOrderDetailsMap - Map
  - getTargetedItemsMap
```
public java.util.Map<java.lang.String,java.lang.Long> getTargetedItemsMap()
```
    Getter for the map of commerce item id to quantity targeted to be free.
    
    Returns:
    
    Map
  - setTargetedItemsMap
```
public void setTargetedItemsMap(java.util.Map<java.lang.String,java.lang.Long> pTargetedItemsMap)
```
    Setter for the map of commerce item id to quantity targeted to be free.
    
    Parameters:
    
    pTargetedItemsMap - Map
  - getTargetedItemsWithFractionMap
```
public java.util.Map<java.lang.String,java.lang.Double> getTargetedItemsWithFractionMap()
```
    Getter for the map of commerce item id to quantity targeted to be free.
    
    Returns:
    
    Map
  - setTargetedItemsWithFractionMap
```
public void setTargetedItemsWithFractionMap(java.util.Map<java.lang.String,java.lang.Double> pTargetedItemsWithFractionMap)
```
    Setter for the map of commerce item id to quantity targeted to be free.
    
    Parameters:
    
    pTargetedItemsWithFractionMap - Map
  - getMarker
```
public RepositoryItem getMarker()
```
    Getter for the existing order marker related to this info (if any)
    
    Returns:
    
    RepositoryItem GWP order marker.
  - setMarker
```
public void setMarker(RepositoryItem pMarker)
```
    Setter for the existing order marker related to this info (if any)
    
    Parameters:
    
    pMarker - RepositoryItem marker
  - setLastTargetSetUUID
```
public void setLastTargetSetUUID(java.util.UUID pLastTargetSetUUID)
```
    Set property LastTargetSetUUID.
    
    Parameters:
    
    pLastTargetSetUUID - the UUID for the last target set that increased this GWPInfo quantity
  - getLastTargetSetUUID
```
public java.util.UUID getLastTargetSetUUID()
```
    Get property LastTargetSetUUID
    
    Returns:
    
    the UUID for the last target set that increased this GWPInfo quantity
  - getTargetableItems
```
public java.util.Map<QualifiedItem,java.lang.Integer> getTargetableItems()
```
  - setTargetableItems
```
public void setTargetableItems(java.util.Map<QualifiedItem,java.lang.Integer> pTargetableItems)
```
  - increaseQuantity
```
public void increaseQuantity(DiscountDetail pDiscountDetail,
                             int pOfferCount)
                      throws PricingException
```
    Method to increase the quantity by the amount in the given discount detail
    
    Parameters:
    
    pDiscountDetail - DiscountDetail to get quantity to add
    
    pOfferCount - int number of times this discount offer should apply
    
    Throws:
    
    PricingException
  - merge
```
public void merge(GWPInfo pGWPInfo)
```
    Merge the given GWPInfo with this one. Can happen if QualifiedItem's for a given GWP promotion instance are split across multiple batches in the pricing engine.
    
    Parameters:
    
    pGWPInfo -
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class GWPInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

mPromotionId

mGiftHashCode

mQuantity

mQuantityWithFraction

mTargetedQuantity

mTargetedQuantityWithFraction

mOrderDetailsMap

mTargetedItemsMap

mTargetedItemsWithFractionMap

mMarker

Constructor Detail

GWPInfo

Method Detail

getPromotionId

setPromotionId

getGiftHashCode

setGiftHashCode

getQuantity

setQuantity

getQuantityWithFraction

setQuantityWithFraction

getQuantityDerivedAsFloatingPoint

getTargetedQuantity

setTargetedQuantity

getTargetedQuantityWithFraction

setTargetedQuantityWithFraction

getTargetedQuantityDerivedAsFloatingPoint

getOrderDetailsMap

setOrderDetailsMap

getTargetedItemsMap

setTargetedItemsMap

getTargetedItemsWithFractionMap

setTargetedItemsWithFractionMap

getMarker

setMarker

setLastTargetSetUUID

getLastTargetSetUUID

getTargetableItems

setTargetableItems

increaseQuantity

merge

toString