com.ibm.commerce.price.utils

Class CatEntryPriceKey

java.lang.Object

com.ibm.commerce.price.utils.CatEntryPriceKey

public class CatEntryPriceKey
extends java.lang.Object

This utility class is used to help the best price selection and price input filter in price commands.

Constructor Summary

Constructors

Constructor and Description
CatEntryPriceKey(CatEntryPrices catEntry) Constructor to build an instance from a CatEntryPrices.
CatEntryPriceKey(java.lang.Long newCatEntryID, QuantityAmount newQuantity) Constructor to build an instance from a catalog entry ID and a quantity amount, with a null order item ID.
CatEntryPriceKey(java.lang.Long newCatEntryID, QuantityAmount newQuantity, com.ibm.commerce.order.objects.OrderItemAccessBean newOrderItem) Constructor to build an instance from a catalog entry ID, a quantity amount, and an order item ID from an order item.
CatEntryPriceKey(PriceInputCase priceInputCase) Constructor to build an instance from a PriceInputCase.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Long	getCatEntryId() Returns the catalog entry identifier.
java.lang.Long	getOrderItemID() Returns the order item identifier.
QuantityAmount	getQuantity() Returns the quantity.
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CatEntryPriceKey

public CatEntryPriceKey(CatEntryPrices catEntry)

Constructor to build an instance from a CatEntryPrices.

Parameters:

catEntry - The catalog entry that contains the catalog entry identifier, quantity and order item ID to use. Cannot be null.

CatEntryPriceKey

public CatEntryPriceKey(java.lang.Long newCatEntryID,
                        QuantityAmount newQuantity)

Constructor to build an instance from a catalog entry ID and a quantity amount, with a null order item ID.

Parameters:

newCatEntryID - The catalog entry identifier. Cannot be null.

newQuantity - The quantity amount. Cannot be null.

CatEntryPriceKey

public CatEntryPriceKey(java.lang.Long newCatEntryID,
                        QuantityAmount newQuantity,
                        com.ibm.commerce.order.objects.OrderItemAccessBean newOrderItem)

Constructor to build an instance from a catalog entry ID, a quantity amount, and an order item ID from an order item.

Parameters:

newCatEntryID - The catalog entry identifier. Cannot be null.

newQuantity - The quantity amount. Cannot be null.

newOrderItem - The order item. May be null.

CatEntryPriceKey

public CatEntryPriceKey(PriceInputCase priceInputCase)

Constructor to build an instance from a PriceInputCase.

Parameters:

priceInputCase - The price input case used to build an instance. Cannot be null.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getCatEntryId

public java.lang.Long getCatEntryId()

Returns the catalog entry identifier.

Returns:

The catalog entry identifier. This value will not be null.

getOrderItemID

public java.lang.Long getOrderItemID()

Returns the order item identifier.

Returns:

The order item identifier. This value may be null.

getQuantity

public QuantityAmount getQuantity()

Returns the quantity.

Returns:

The quantity. This value will not be null.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object