|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectatg.commerce.pricing.FilteredCommerceItem
public class FilteredCommerceItem
Represents a CommerceItem that's currently participating in a rules evaluation in the Qualifier. This object holds a reference to the object it is wrapping:
item
points to the wrapped CommerceItem
All CommerceItem methods call through to the wrapped item except for
quantity
.
FilteredCommerceItem adds two properties which are used to determine if/how the wrapped CommerceItem should participate in pricing:
CommerceItem
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
DETAILS_RANGES_VALID_FOR_TARGET
|
protected java.util.LinkedHashMap<DetailedItemPriceInfo,java.util.List<atg.core.util.Range>> |
mDetailsRangesValidForQualifier
Map of DIPI to List of Range's that are valid to be evaluated as qualifiers |
static java.lang.String |
PRICE_INFO
|
static java.lang.String |
QUANTITY_AS_QUALIFIER_DETAILS
|
static java.lang.String |
QUANTITY_PROPERTY_NAME
|
static long |
serialVersionUID
|
static java.lang.String |
WRAPPED_ITEM
|
Constructor Summary | |
---|---|
FilteredCommerceItem(CommerceItem pItem)
Constructs an instanceof PricingCommerceItem |
Method Summary | |
---|---|
void |
addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship)
Add the PaymentGroupRelationship to the container. |
void |
addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship,
int pIndex)
Add the PaymentGroupRelationship to the container at the given index. |
void |
addShippingGroupRelationship(ShippingGroupRelationship pShippingGroupRelationship)
Add the ShippingGroupRelationship to the container. |
void |
addShippingGroupRelationship(ShippingGroupRelationship pShippingGroupRelationship,
int pIndex)
Add the ShippingGroupRelationship to the container at the given index. |
FilteredCommerceItem |
clone()
Shallow clones this filtered commerce item |
AuxiliaryData |
getAuxiliaryData()
returns the AuxiliaryData. |
java.lang.String |
getCatalogId()
Returns property CatalogId |
java.lang.String |
getCatalogKey()
Returns property CatalogKey |
java.lang.String |
getCatalogRefId()
Returns property CatalogRefId |
java.lang.String |
getCommerceItemClassType()
Returns the commerceItemClassType |
java.util.LinkedHashMap<DetailedItemPriceInfo,java.util.List<atg.core.util.Range>> |
getDetailsRangesValidForQualifier()
Getter for the map of DIPI to List of Range's that are valid to be evaluated as qualifiers |
java.util.Map |
getDetailsRangesValidForTarget()
map of DetailedItemPriceInfos to the list of ranges of each details that is available for discounting basic on the exclusion rules defined by various properties in Qualifier. |
java.lang.String |
getId()
Returns property Id |
PaymentGroupRelationship |
getPaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId)
Returns the PaymentGroupRelationship whose id is pPaymentGroupRelationshipId. |
int |
getPaymentGroupRelationshipCount()
Returns the number of PaymentGroupRelationships in the container. |
java.util.List |
getPaymentGroupRelationships()
Returns a List of PaymentGroupRelationships |
ItemPriceInfo |
getPriceInfo()
Returns property PriceInfo |
ItemPriceInfo |
getPriceQuote()
|
java.lang.Object |
getPropertyValue(java.lang.String pPropertyName)
Just in case the filtered commerce item has properties we don't explicitly provide here, this method can be used. |
long |
getQuantity()
Returns property Quantity |
java.util.Map |
getQuantityAsQualifierDetails()
linked hash map of DetailedItemPriceInfo objects to list of Range objects which state which units of the details have acted as a qualifier for something |
long |
getReturnedQuantity()
Returns the returnedQuantity |
ShippingGroupRelationship |
getShippingGroupRelationship(java.lang.String pShippingGroupRelationshipId)
Returns the ShippingGroupRelationship whose id is pShippingGroupRelationshipId. |
int |
getShippingGroupRelationshipCount()
Returns the number of ShippingGroupRelationships in the container. |
java.util.List |
getShippingGroupRelationships()
Returns a List of ShippingGroupRelationships |
int |
getState()
Returns property State |
java.lang.String |
getStateDetail()
Returns property StateDetail |
CommerceItem |
getWrappedItem()
|
void |
removeAllPaymentGroupRelationships()
Removes all the PaymentGroupRelationships |
void |
removeAllShippingGroupRelationships()
Removes all the ShippingGroupRelationships |
PaymentGroupRelationship |
removePaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId)
Removes a PaymentGroupRelationship whose id is passed in. |
ShippingGroupRelationship |
removeShippingGroupRelationship(java.lang.String pShippingGroupRelationshipId)
Removes a ShippingGroupRelationship whose id is passed in. |
void |
setCatalogId(java.lang.String pCatalogId)
Sets property CatalogId |
void |
setCatalogKey(java.lang.String pCatalogKey)
Sets property CatalogKey |
void |
setCatalogRefId(java.lang.String pCatalogRefId)
Sets property CatalogRefId |
void |
setCommerceItemClassType(java.lang.String pCommerceItemClassType)
Sets the commerceItemClassType |
void |
setDetailsRangesValidForQualifier(java.util.LinkedHashMap<DetailedItemPriceInfo,java.util.List<atg.core.util.Range>> pDetailsRangesValidForQualifier)
Setter for the map of DIPI to List of Range's that are valid to be evaluated as qualifiers |
void |
setDetailsRangesValidForTarget(java.util.LinkedHashMap<DetailedItemPriceInfo,java.util.List<atg.core.util.Range>> pDetailsRangesValidForTarget)
Setter for the map of DetailedItemPriceInfos to the list of ranges of each details that is available for discounting. |
void |
setDetailsRangesValidForTarget(java.util.Map pDetailsRangesValidForTarget)
Deprecated. since we should use a LinkedHashMap to maintain order, see COMMERCE-168079, replaced by setDetailsRangesValidForTarget(LinkedHashMap) |
void |
setPriceInfo(ItemPriceInfo pPriceInfo)
Sets property PriceInfo |
void |
setPriceQuote(ItemPriceInfo pPriceQuote)
|
void |
setPropertyValue(java.lang.String pPropertyName,
java.lang.Object pPropertyValue)
Just in case the filtered commerce item has properties we don't explicitly provide here, this method can be used. |
void |
setQuantity(long pQuantity)
Sets property Quantity |
void |
setQuantityAsQualifierDetails(java.util.LinkedHashMap<DetailedItemPriceInfo,java.util.List<atg.core.util.Range>> pQuantityAsQualifierDetails)
linked hash map of DetailedItemPriceInfo objects to list of Range objects which state which units of the details have acted as a qualifier for something |
void |
setState(int pState)
Sets property State |
void |
setStateDetail(java.lang.String pStateDetail)
Sets property StateDetail |
void |
setUsePriceQuote(boolean pUsePriceQuote)
|
java.lang.String |
toString()
Generate a nice string. |
boolean |
usePriceQuote()
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final long serialVersionUID
public static final java.lang.String CLASS_VERSION
public static final java.lang.String QUANTITY_PROPERTY_NAME
public static final java.lang.String QUANTITY_AS_QUALIFIER_DETAILS
public static final java.lang.String DETAILS_RANGES_VALID_FOR_TARGET
public static final java.lang.String WRAPPED_ITEM
public static final java.lang.String PRICE_INFO
protected java.util.LinkedHashMap<DetailedItemPriceInfo,java.util.List<atg.core.util.Range>> mDetailsRangesValidForQualifier
Constructor Detail |
---|
public FilteredCommerceItem(CommerceItem pItem)
pItem
- Method Detail |
---|
public ItemPriceInfo getPriceQuote()
public void setPriceQuote(ItemPriceInfo pPriceQuote)
public boolean usePriceQuote()
public void setUsePriceQuote(boolean pUsePriceQuote)
public java.util.Map getQuantityAsQualifierDetails()
public void setQuantityAsQualifierDetails(java.util.LinkedHashMap<DetailedItemPriceInfo,java.util.List<atg.core.util.Range>> pQuantityAsQualifierDetails)
pQuantityAsQualifierDetails
- public java.util.Map getDetailsRangesValidForTarget()
The map should be a LinkedHashMap to maintain order of the entries, see COMMERCE-168079.
@Deprecated public void setDetailsRangesValidForTarget(java.util.Map pDetailsRangesValidForTarget)
setDetailsRangesValidForTarget(LinkedHashMap)
The map should be a LinkedHashMap to maintain order of the entries, see COMMERCE-168079.
public void setDetailsRangesValidForTarget(java.util.LinkedHashMap<DetailedItemPriceInfo,java.util.List<atg.core.util.Range>> pDetailsRangesValidForTarget)
The map should be a LinkedHashMap to maintain order of the entries, see COMMERCE-168079.
public java.util.LinkedHashMap<DetailedItemPriceInfo,java.util.List<atg.core.util.Range>> getDetailsRangesValidForQualifier()
public void setDetailsRangesValidForQualifier(java.util.LinkedHashMap<DetailedItemPriceInfo,java.util.List<atg.core.util.Range>> pDetailsRangesValidForQualifier)
pDetailsRangesValidForQualifier
- Map of DIPI to List of Range's that are valid to be evaluated as qualifierspublic CommerceItem getWrappedItem()
public void setQuantity(long pQuantity)
setQuantity
in interface CommerceItem
pQuantity
- public long getQuantity()
getQuantity
in interface CommerceItem
public java.lang.String getId()
getId
in interface CommerceIdentifier
public void setCommerceItemClassType(java.lang.String pCommerceItemClassType)
setCommerceItemClassType
in interface CommerceItem
pCommerceItemClassType
- public java.lang.String getCommerceItemClassType()
getCommerceItemClassType
in interface CommerceItem
public void setCatalogKey(java.lang.String pCatalogKey)
setCatalogKey
in interface CommerceItem
pCatalogKey
- public java.lang.String getCatalogKey()
getCatalogKey
in interface CommerceItem
public void setCatalogId(java.lang.String pCatalogId)
setCatalogId
in interface CommerceItem
pCatalogId
- public java.lang.String getCatalogId()
getCatalogId
in interface CommerceItem
public void setCatalogRefId(java.lang.String pCatalogRefId)
setCatalogRefId
in interface CommerceItem
pCatalogRefId
- public java.lang.String getCatalogRefId()
getCatalogRefId
in interface CommerceItem
public long getReturnedQuantity()
getReturnedQuantity
in interface CommerceItem
public void setState(int pState)
setState
in interface CommerceItem
pState
- public int getState()
getState
in interface CommerceItem
public void setStateDetail(java.lang.String pStateDetail)
setStateDetail
in interface CommerceItem
pStateDetail
- public java.lang.String getStateDetail()
getStateDetail
in interface CommerceItem
public void setPriceInfo(ItemPriceInfo pPriceInfo)
setPriceInfo
in interface CommerceItem
pPriceInfo
- public ItemPriceInfo getPriceInfo()
getPriceInfo
in interface CommerceItem
public AuxiliaryData getAuxiliaryData()
getAuxiliaryData
in interface CommerceItem
public java.util.List getShippingGroupRelationships()
getShippingGroupRelationships
in interface ShippingGroupRelationshipContainer
public void addShippingGroupRelationship(ShippingGroupRelationship pShippingGroupRelationship) throws DuplicateRelationshipException, InvalidParameterException
addShippingGroupRelationship
in interface ShippingGroupRelationshipContainer
pShippingGroupRelationship
- the ShippingRelationshipGroup to be added
DuplicateRelationshipException
InvalidParameterException
public void addShippingGroupRelationship(ShippingGroupRelationship pShippingGroupRelationship, int pIndex) throws DuplicateRelationshipException, InvalidParameterException
addShippingGroupRelationship
in interface ShippingGroupRelationshipContainer
pShippingGroupRelationship
- The ShippingGroupRelationship to be addedpIndex
- the index in the container that this ShippingGroupRelationship will be added
DuplicateRelationshipException
InvalidParameterException
public ShippingGroupRelationship removeShippingGroupRelationship(java.lang.String pShippingGroupRelationshipId) throws RelationshipNotFoundException, InvalidParameterException
removeShippingGroupRelationship
in interface ShippingGroupRelationshipContainer
pShippingGroupRelationshipId
- the Id of the ShippingGroupRelationship
RelationshipNotFoundException
InvalidParameterException
public void removeAllShippingGroupRelationships()
removeAllShippingGroupRelationships
in interface ShippingGroupRelationshipContainer
public ShippingGroupRelationship getShippingGroupRelationship(java.lang.String pShippingGroupRelationshipId) throws RelationshipNotFoundException, InvalidParameterException
getShippingGroupRelationship
in interface ShippingGroupRelationshipContainer
pShippingGroupRelationshipId
- The Id of the ShippingGroupRelationship
RelationshipNotFoundException
InvalidParameterException
public int getShippingGroupRelationshipCount()
getShippingGroupRelationshipCount
in interface ShippingGroupRelationshipContainer
public java.util.List getPaymentGroupRelationships()
getPaymentGroupRelationships
in interface PaymentGroupRelationshipContainer
public void addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship) throws DuplicateRelationshipException, InvalidParameterException
addPaymentGroupRelationship
in interface PaymentGroupRelationshipContainer
pPaymentGroupRelationship
- the PaymentRelationshipGroup to be added
DuplicateRelationshipException
InvalidParameterException
public void addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship, int pIndex) throws DuplicateRelationshipException, InvalidParameterException
addPaymentGroupRelationship
in interface PaymentGroupRelationshipContainer
pPaymentGroupRelationship
- The PaymentGroupRelationship to be addedpIndex
- the index in the container that this PaymentGroupRelationship will be added
DuplicateRelationshipException
InvalidParameterException
public PaymentGroupRelationship removePaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId) throws RelationshipNotFoundException, InvalidParameterException
removePaymentGroupRelationship
in interface PaymentGroupRelationshipContainer
pPaymentGroupRelationshipId
- the Id of the PaymentFroupRelationship
RelationshipNotFoundException
InvalidParameterException
public void removeAllPaymentGroupRelationships()
removeAllPaymentGroupRelationships
in interface PaymentGroupRelationshipContainer
public PaymentGroupRelationship getPaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId) throws RelationshipNotFoundException, InvalidParameterException
getPaymentGroupRelationship
in interface PaymentGroupRelationshipContainer
pPaymentGroupRelationshipId
- - the Id of the PaymentGroupRelationship
RelationshipNotFoundException
InvalidParameterException
public int getPaymentGroupRelationshipCount()
getPaymentGroupRelationshipCount
in interface PaymentGroupRelationshipContainer
public java.lang.Object getPropertyValue(java.lang.String pPropertyName) throws PropertyNotFoundException
pPropertyName
- The name of the commerce item property
PropertyNotFoundException
public void setPropertyValue(java.lang.String pPropertyName, java.lang.Object pPropertyValue) throws PropertyNotFoundException
pPropertyName
- The name of the commerce item propertypPropertyValue
- The value to set the property to
PropertyNotFoundException
public java.lang.String toString()
toString
in class java.lang.Object
CommerceItemImpl.toString()
public FilteredCommerceItem clone()
clone
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |