GiftWithPurchaseSelection (ATG Java API)

java.lang.Object
- atg.commerce.promotion.GiftWithPurchaseSelection

```
public class GiftWithPurchaseSelection
extends java.lang.Object
```
Class to represent a single gift selection available for a gift with purchase promotion. The GiftWithPurchaseSelectionsDroplet will output a collection of these for an order. It contains the various quantities associated with the promotion and gift in the order or item.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION`
`protected long`	`mAutomaticQuantity` Quantity automatically added
`protected double`	`mAutomaticQuantityWithFraction`
`protected long`	`mFailedQuantity` Quantity failed to auto add (only applied for orders)
`protected double`	`mFailedQuantityWithFraction`
`protected java.lang.String`	`mGiftDetail`
`protected int`	`mGiftHashCode`
`protected java.lang.String`	`mGiftType`
`protected java.lang.String`	`mPromotionId`
`protected long`	`mQuantity` Total quantity given away by this promotion for this gift
`protected double`	`mQuantityWithFraction`
`protected long`	`mRemovedQuantity` Quantity manually removed (only applied for orders)
`protected double`	`mRemovedQuantityWithFraction`
`protected long`	`mSelectedQuantity` Quantity already selected
`protected double`	`mSelectedQuantityWithFraction`
`protected long`	`mTargetedQuantity` Quantity targeted by pricing
`protected double`	`mTargetedQuantityWithFraction`

Constructor Summary

Constructors
Constructor and Description
`GiftWithPurchaseSelection()` Default constructor
`GiftWithPurchaseSelection(atg.commerce.promotion.GWPMarkerManager pManager, RepositoryItem pOrderMarker)` Constructor to create a selection object based on a given GWP order marker.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getAutomaticQuantity()` Getter for the quantity already automatically added to the order
`double`	`getAutomaticQuantityWithFraction()` Getter for the quantity already automatically added to the order
`long`	`getFailedQuantity()` Getter for the quantity failed to auto add in the order
`double`	`getFailedQuantityWithFraction()` Getter for the quantity failed to auto add in the order
`java.lang.String`	`getGiftDetail()` Getter for the gift detail
`int`	`getGiftHashCode()` Getter for the gift hash code
`java.lang.String`	`getGiftType()` Getter for the gift type
`java.lang.String`	`getPromotionId()` Getter for the promotion id
`long`	`getQuantity()` Getter for the total quantity given away by this promotion for this gift
`long`	`getQuantityAvailableForSelection()` Getter for the quantity available still available to be selected
`double`	`getQuantityDerivedAsFloatingPoint()` Returns derived quantity, returning quantityWithFraction if non-zero, and quantity otherwise
`long`	`getQuantityMissingFromOrder()` Getter for the quantity missing from the order
`double`	`getQuantityWithFraction()` Getter for the total quantity given away by this promotion for this gift
`double`	`getQuantityWithFractionAvailableForSelection()` Getter for the quantity (totals of fractional and non-fractional values) still available to be selected
`double`	`getQuantityWithFractionMissingFromOrder()` Getter for the quantity (totals of fractional and non-fractional values) missing from the order
`long`	`getRemovedQuantity()` Getter for the quantity manually removed in the order
`double`	`getRemovedQuantityWithFraction()` Getter for the quantity manually removed in the order
`long`	`getSelectedQuantity()` Getter for the quantity already selected and added to the order
`double`	`getSelectedQuantityWithFraction()` Getter for the quantity already selected and added to the order
`long`	`getTargetedQuantity()` Getter for the quantity already in the order that was targeted by pricing
`double`	`getTargetedQuantityWithFraction()` Getter for the quantity already in the order that was targeted by pricing
`double`	`getTotalAutomaticQuantity()` Returns the total combined automatic quantity (fractional and non-fractional)
`double`	`getTotalFailedQuantity()` Returns the total combined failed quantity (fractional and non-fractional)
`double`	`getTotalRemovedQuantity()` Returns the total combined removed quantity (fractional and non-fractional)
`double`	`getTotalSelectedQuantity()` Returns the total combined selected quantity (fractional and non-fractional)
`double`	`getTotalTargetedQuantity()` Returns the total combined targeted quantity (fractional and non-fractional)
`void`	`setAutomaticQuantity(long pAutomaticQuantity)` Setter for the quantity already automatically added to the order
`void`	`setAutomaticQuantityWithFraction(double pAutomaticQuantityWithFraction)` Setter for the quantity already automatically added to the order
`void`	`setFailedQuantity(long pFailedQuantity)` Setter for the quantity failed to auto add in the order
`void`	`setFailedQuantityWithFraction(double pFailedQuantityWithFraction)` Setter for the quantity failed to auto add in the order
`void`	`setGiftDetail(java.lang.String pGiftDetail)` Setter for the gift detail
`void`	`setGiftHashCode(int pGiftHashCode)` Setter for the gift hash code
`void`	`setGiftType(java.lang.String pGiftType)` Setter for the gift type
`void`	`setPromotionId(java.lang.String pPromotionId)` Setter for the promotion id
`void`	`setQuantity(long pQuantity)` Setter for the total quantity given away by this promotion for this gift
`void`	`setQuantityWithFraction(double pQuantityWithFraction)` Setter for the total quantity given away by this promotion for this gift
`void`	`setRemovedQuantity(long pRemovedQuantity)` Setter for the quantity manually removed in the order
`void`	`setRemovedQuantityWithFraction(double pRemovedQuantityWithFraction)` Setter for the quantity manually removed in the order
`void`	`setSelectedQuantity(long pSelectedQuantity)` Setter for the quantity already selected and added to the order
`void`	`setSelectedQuantityWithFraction(double pSelectedQuantityWithFraction)` Setter for the quantity already selected and added to the order
`void`	`setTargetedQuantity(long pTargetedQuantity)` Setter for the quantity already in the order that was targeted by pricing
`void`	`setTargetedQuantityWithFraction(double pTargetedQuantityWithFraction)` Setter for the quantity already in the order that was targeted by pricing
`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 java.lang.String CLASS_VERSION
```
  - mPromotionId
```
protected java.lang.String mPromotionId
```
  - mGiftHashCode
```
protected int mGiftHashCode
```
  - mGiftType
```
protected java.lang.String mGiftType
```
  - mGiftDetail
```
protected java.lang.String mGiftDetail
```
  - mQuantity
```
protected long mQuantity
```
    Total quantity given away by this promotion for this gift
  - mQuantityWithFraction
```
protected double mQuantityWithFraction
```
  - mAutomaticQuantity
```
protected long mAutomaticQuantity
```
    Quantity automatically added
  - mAutomaticQuantityWithFraction
```
protected double mAutomaticQuantityWithFraction
```
  - mSelectedQuantity
```
protected long mSelectedQuantity
```
    Quantity already selected
  - mSelectedQuantityWithFraction
```
protected double mSelectedQuantityWithFraction
```
  - mTargetedQuantity
```
protected long mTargetedQuantity
```
    Quantity targeted by pricing
  - mTargetedQuantityWithFraction
```
protected double mTargetedQuantityWithFraction
```
  - mRemovedQuantity
```
protected long mRemovedQuantity
```
    Quantity manually removed (only applied for orders)
  - mRemovedQuantityWithFraction
```
protected double mRemovedQuantityWithFraction
```
  - mFailedQuantity
```
protected long mFailedQuantity
```
    Quantity failed to auto add (only applied for orders)
  - mFailedQuantityWithFraction
```
protected double mFailedQuantityWithFraction
```
- Constructor Detail
  - GiftWithPurchaseSelection
```
public GiftWithPurchaseSelection()
```
    Default constructor
  - GiftWithPurchaseSelection
```
public GiftWithPurchaseSelection(atg.commerce.promotion.GWPMarkerManager pManager,
                                 RepositoryItem pOrderMarker)
```
    Constructor to create a selection object based on a given GWP order marker.
    
    Parameters:
    
    pManager - GWPMarkerManager to get quantites from the given order marker
    
    pOrderMarker - RepositoryItem GWP order marker
- Method Detail
  - getPromotionId
```
public java.lang.String getPromotionId()
```
    Getter for the promotion id
    
    Returns:
    
    String
  - setPromotionId
```
public void setPromotionId(java.lang.String pPromotionId)
```
    Setter for the promotion id
    
    Parameters:
    
    pPromotionId - String
  - getGiftHashCode
```
public int getGiftHashCode()
```
    Getter for the gift hash code
    
    Returns:
    
    int
  - setGiftHashCode
```
public void setGiftHashCode(int pGiftHashCode)
```
    Setter for the gift hash code
    
    Parameters:
    
    pGiftHashCode - int
  - getGiftType
```
public java.lang.String getGiftType()
```
    Getter for the gift type
    
    Returns:
    
    String
  - setGiftType
```
public void setGiftType(java.lang.String pGiftType)
```
    Setter for the gift type
    
    Parameters:
    
    pGiftType - String
  - getGiftDetail
```
public java.lang.String getGiftDetail()
```
    Getter for the gift detail
    
    Returns:
    
    String
  - setGiftDetail
```
public void setGiftDetail(java.lang.String pGiftDetail)
```
    Setter for the gift detail
    
    Parameters:
    
    pGiftDetail - String
  - getQuantity
```
public long getQuantity()
```
    Getter for the total quantity given away by this promotion for this gift
    
    Returns:
    
    long
  - setQuantity
```
public void setQuantity(long pQuantity)
```
    Setter for the total quantity given away by this promotion for this gift
    
    Parameters:
    
    pQuantity - long
  - getQuantityWithFraction
```
public double getQuantityWithFraction()
```
    Getter for the total quantity given away by this promotion for this gift
    
    Returns:
    
    long
  - setQuantityWithFraction
```
public void setQuantityWithFraction(double pQuantityWithFraction)
```
    Setter for the total quantity given away by this promotion for this gift
    
    Parameters:
    
    pQuantityWithFraction - double
  - getQuantityDerivedAsFloatingPoint
```
public double getQuantityDerivedAsFloatingPoint()
```
    Returns derived quantity, returning quantityWithFraction if non-zero, and quantity otherwise
    
    Returns:
    
    double quantity
  - getAutomaticQuantity
```
public long getAutomaticQuantity()
```
    Getter for the quantity already automatically added to the order
    
    Returns:
    
    long
  - setAutomaticQuantity
```
public void setAutomaticQuantity(long pAutomaticQuantity)
```
    Setter for the quantity already automatically added to the order
    
    Parameters:
    
    pAutomaticQuantity -
  - getAutomaticQuantityWithFraction
```
public double getAutomaticQuantityWithFraction()
```
    Getter for the quantity already automatically added to the order
    
    Returns:
    
    double
  - setAutomaticQuantityWithFraction
```
public void setAutomaticQuantityWithFraction(double pAutomaticQuantityWithFraction)
```
    Setter for the quantity already automatically added to the order
    
    Parameters:
    
    pAutomaticQuantityWithFraction -
  - getTotalAutomaticQuantity
```
public double getTotalAutomaticQuantity()
```
    Returns the total combined automatic quantity (fractional and non-fractional)
    
    Returns:
    
    double total combined automatic quantity (fractional and non-fractional)
  - getSelectedQuantity
```
public long getSelectedQuantity()
```
    Getter for the quantity already selected and added to the order
    
    Returns:
    
    long
  - setSelectedQuantity
```
public void setSelectedQuantity(long pSelectedQuantity)
```
    Setter for the quantity already selected and added to the order
    
    Parameters:
    
    pSelectedQuantity -
  - getSelectedQuantityWithFraction
```
public double getSelectedQuantityWithFraction()
```
    Getter for the quantity already selected and added to the order
    
    Returns:
    
    double
  - setSelectedQuantityWithFraction
```
public void setSelectedQuantityWithFraction(double pSelectedQuantityWithFraction)
```
    Setter for the quantity already selected and added to the order
    
    Parameters:
    
    pSelectedQuantityWithFraction -
  - getTotalSelectedQuantity
```
public double getTotalSelectedQuantity()
```
    Returns the total combined selected quantity (fractional and non-fractional)
    
    Returns:
    
    double total combined selected quantity (fractional and non-fractional)
  - getTargetedQuantity
```
public long getTargetedQuantity()
```
    Getter for the quantity already in the order that was targeted by pricing
    
    Returns:
    
    long
  - setTargetedQuantity
```
public void setTargetedQuantity(long pTargetedQuantity)
```
    Setter for the quantity already in the order that was targeted by pricing
    
    Parameters:
    
    pTargetedQuantity -
  - getTargetedQuantityWithFraction
```
public double getTargetedQuantityWithFraction()
```
    Getter for the quantity already in the order that was targeted by pricing
    
    Returns:
    
    double
  - setTargetedQuantityWithFraction
```
public void setTargetedQuantityWithFraction(double pTargetedQuantityWithFraction)
```
    Setter for the quantity already in the order that was targeted by pricing
    
    Parameters:
    
    pTargetedQuantityWithFraction -
  - getTotalTargetedQuantity
```
public double getTotalTargetedQuantity()
```
    Returns the total combined targeted quantity (fractional and non-fractional)
    
    Returns:
    
    double total combined targeted quantity (fractional and non-fractional)
  - getRemovedQuantity
```
public long getRemovedQuantity()
```
    Getter for the quantity manually removed in the order
    
    Returns:
    
    long
  - setRemovedQuantity
```
public void setRemovedQuantity(long pRemovedQuantity)
```
    Setter for the quantity manually removed in the order
    
    Parameters:
    
    pRemovedQuantity -
  - getRemovedQuantityWithFraction
```
public double getRemovedQuantityWithFraction()
```
    Getter for the quantity manually removed in the order
    
    Returns:
    
    double
  - setRemovedQuantityWithFraction
```
public void setRemovedQuantityWithFraction(double pRemovedQuantityWithFraction)
```
    Setter for the quantity manually removed in the order
    
    Parameters:
    
    pRemovedQuantityWithFraction -
  - getTotalRemovedQuantity
```
public double getTotalRemovedQuantity()
```
    Returns the total combined removed quantity (fractional and non-fractional)
    
    Returns:
    
    double total combined removed quantity (fractional and non-fractional)
  - getFailedQuantity
```
public long getFailedQuantity()
```
    Getter for the quantity failed to auto add in the order
    
    Returns:
    
    long
  - setFailedQuantity
```
public void setFailedQuantity(long pFailedQuantity)
```
    Setter for the quantity failed to auto add in the order
    
    Parameters:
    
    pFailedQuantity -
  - getFailedQuantityWithFraction
```
public double getFailedQuantityWithFraction()
```
    Getter for the quantity failed to auto add in the order
    
    Returns:
    
    double
  - setFailedQuantityWithFraction
```
public void setFailedQuantityWithFraction(double pFailedQuantityWithFraction)
```
    Setter for the quantity failed to auto add in the order
    
    Parameters:
    
    pFailedQuantityWithFraction -
  - getTotalFailedQuantity
```
public double getTotalFailedQuantity()
```
    Returns the total combined failed quantity (fractional and non-fractional)
    
    Returns:
    
    double total combined failed quantity (fractional and non-fractional)
  - getQuantityAvailableForSelection
```
public long getQuantityAvailableForSelection()
```
    Getter for the quantity available still available to be selected
    Note: manually removed and failed quantity are not included. Does not take into account getTotalXXX() methods.
    
    Returns:
    
    long
  - getQuantityWithFractionAvailableForSelection
```
public double getQuantityWithFractionAvailableForSelection()
```
    Getter for the quantity (totals of fractional and non-fractional values) still available to be selected
    Note: manually removed and failed quantity are not included
    
    Returns:
    
    double
  - getQuantityMissingFromOrder
```
public long getQuantityMissingFromOrder()
```
    Getter for the quantity missing from the order
    Note: manually removed and failed quantity are included
    
    Returns:
    
    long
  - getQuantityWithFractionMissingFromOrder
```
public double getQuantityWithFractionMissingFromOrder()
```
    Getter for the quantity (totals of fractional and non-fractional values) missing from the order
    Note: manually removed and failed quantity are not included
    
    Returns:
    
    double
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class GiftWithPurchaseSelection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

mPromotionId

mGiftHashCode

mGiftType

mGiftDetail

mQuantity

mQuantityWithFraction

mAutomaticQuantity

mAutomaticQuantityWithFraction

mSelectedQuantity

mSelectedQuantityWithFraction

mTargetedQuantity

mTargetedQuantityWithFraction

mRemovedQuantity

mRemovedQuantityWithFraction

mFailedQuantity

mFailedQuantityWithFraction

Constructor Detail

GiftWithPurchaseSelection

GiftWithPurchaseSelection

Method Detail

getPromotionId

setPromotionId

getGiftHashCode

setGiftHashCode

getGiftType

setGiftType

getGiftDetail

setGiftDetail

getQuantity

setQuantity

getQuantityWithFraction

setQuantityWithFraction

getQuantityDerivedAsFloatingPoint

getAutomaticQuantity

setAutomaticQuantity

getAutomaticQuantityWithFraction

setAutomaticQuantityWithFraction

getTotalAutomaticQuantity

getSelectedQuantity

setSelectedQuantity

getSelectedQuantityWithFraction

setSelectedQuantityWithFraction

getTotalSelectedQuantity

getTargetedQuantity

setTargetedQuantity

getTargetedQuantityWithFraction

setTargetedQuantityWithFraction

getTotalTargetedQuantity

getRemovedQuantity

setRemovedQuantity

getRemovedQuantityWithFraction

setRemovedQuantityWithFraction

getTotalRemovedQuantity

getFailedQuantity

setFailedQuantity

getFailedQuantityWithFraction

setFailedQuantityWithFraction

getTotalFailedQuantity

getQuantityAvailableForSelection

getQuantityWithFractionAvailableForSelection

getQuantityMissingFromOrder

getQuantityWithFractionMissingFromOrder

toString