com.ibm.commerce.price.commands

Class AbstractGetEntitledPriceCmdImpl

java.lang.Object

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.price.commands.AbstractGetEntitledPriceCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, com.ibm.commerce.command.TaskCommand, GetContractSpecialPriceCmd, GetContractUnitPriceCmd, GetEntitledPriceCmd, GetProductContractUnitPriceCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

Direct Known Subclasses:

GetCachedEntitledPriceCmdImpl, GetExternalEntitledPriceCmdImpl, GetExternalEntitledPriceWithCacheCheckCmdImpl

public abstract class AbstractGetEntitledPriceCmdImpl
extends com.ibm.commerce.command.TaskCommandImpl
implements GetContractUnitPriceCmd, GetContractSpecialPriceCmd, GetProductContractUnitPriceCmd, GetEntitledPriceCmd

This abstract task command is used as the base implementation for task commands which get entitled price from external system using different data retrieval policy.

Field Summary

Fields inherited from interface com.ibm.commerce.price.commands.GetContractUnitPriceCmd

NAME

Fields inherited from interface com.ibm.commerce.price.commands.GetContractSpecialPriceCmd

NAME

Fields inherited from interface com.ibm.commerce.price.commands.GetProductContractUnitPriceCmd

defaultCommandClassName, NAME

Fields inherited from interface com.ibm.commerce.price.commands.GetEntitledPriceCmd

defaultCommandClassName, NAME

Constructor Summary

Constructors

Constructor and Description
AbstractGetEntitledPriceCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Long[]	getApplicableTradingIds() This method, inherited from the parent class, is not supported for integration with an external price management system.
MonetaryAmount[]	getApplicableTradingUnitPrices() This method, inherited from the parent class, is not supported for integration with an external price management system.
MonetaryAmount	getBasePrice() This method, inherited from the parent class, is not supported for integration with an external price management system.
java.lang.Long	getCatEntryId() Returns the id of the input catalog entry.
CatEntryPrices[]	getCatEntryPrices() This method returns the price related information of the input catalog entries.
java.lang.String	getCurrency() This method returns the currency of catalog entry.
com.ibm.commerce.order.objects.OfferAccessBean	getOffer() This method, inherited from the parent class, is not supported for integration with an external price management system.
java.lang.Long	getOfferId() This method, inherited from the parent class, is not supported for integration with an external price management system.
MonetaryAmount	getPrice() This method returns the best price of the catalog entry.
QuantityAmount	getQuantity() This method returns quantity of a catalog entry.
java.lang.Integer	getStoreId() Returns the store id.
java.lang.Long	getTcId() This method, inherited from the parent class, is not supported for integration with an external price management system.
java.lang.Long	getTradingId() This method, inherited from the parent class, is not supported for integration with an external price management system.
void	performExecute() This method executes main business logic of the command: Firstly, it normalizes input parameters and map catalog entry ID between catalog entry part number.
void	reset() Resets the command.
void	setCatEntryId(java.lang.Long aCatEntryId) This method sets the Long value as input catalog entry ID.
void	setCatEntryPrices(CatEntryPrices[] aCatEntryPrices) This method sets the information of one or more catalog entries using CatEntryPrices array.
void	setCurrency(java.lang.String astrCurrency) This method sets a currency which is used for finding the entitled price.
void	setErrorMode(boolean aErrorMode) Sets the flag to indicate if exception will be thrown when the price cannot be found
void	setMemberId(java.lang.Long anMemberId) This method, inherited from the parent class, is not supported for integration with an external price management system.
void	setOfferIds(java.lang.Long[] aOfferIds) This method, inherited from the parent class, is not supported for integration with an external price management system.
void	setOrderItemAccessBean(com.ibm.commerce.order.objects.OrderItemAccessBean aOrderItemAccessBean) This method, inherited from the parent class, is not supported for integration with an external price management system.
void	setOrganizationId(java.lang.Long anOrganizationId) This method, inherited from the parent class, is not supported for integration with an external price management system.
void	setQuantity(QuantityAmount aQuantityAmount) Sets the quantity amount of the input catalog entry that is to be priced.
void	setStoreId(java.lang.Integer aStoreId) Sets the id of the input store to be used for calculating the price .
void	setTradingIds(java.lang.Long[] aTradingIds) This method, inherited from the parent class, is not supported for integration with an external price management system.
void	validateParameters() This method performs server side parameter checking, validates the mandatory parameters.

Methods inherited from class java.lang.Object

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

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Constructor Detail

AbstractGetEntitledPriceCmdImpl

public AbstractGetEntitledPriceCmdImpl()

Method Detail

getApplicableTradingIds

public java.lang.Long[] getApplicableTradingIds()

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

getApplicableTradingIds in interface GetContractSpecialPriceCmd

Specified by:

getApplicableTradingIds in interface GetContractUnitPriceCmd

Specified by:

getApplicableTradingIds in interface GetProductContractUnitPriceCmd

Returns:

The identifiers of all the trading agreements that were used to obtain the prices for the specified catalog entry. This array may be null or empty if GetContractUnitPriceCmd.getPrice() returns null.

See Also:

GetProductContractUnitPriceCmd.getApplicableTradingIds()

getApplicableTradingUnitPrices

public MonetaryAmount[] getApplicableTradingUnitPrices()

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

getApplicableTradingUnitPrices in interface GetContractSpecialPriceCmd

Specified by:

getApplicableTradingUnitPrices in interface GetContractUnitPriceCmd

Specified by:

getApplicableTradingUnitPrices in interface GetProductContractUnitPriceCmd

Returns:

The unit price amounts of the specified catalog entry in that each of them was determined individually for its corresponding trading agreement. This array may be null or empty if GetContractUnitPriceCmd.getPrice() returns null.

See Also:

GetProductContractUnitPriceCmd.getApplicableTradingUnitPrices()

getBasePrice

public MonetaryAmount getBasePrice()

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

getBasePrice in interface GetContractSpecialPriceCmd

Specified by:

getBasePrice in interface GetContractUnitPriceCmd

Specified by:

getBasePrice in interface GetProductContractUnitPriceCmd

Returns:

The best price found for the specified catalog entry. This value will be null if no currency conversion was performed to obtain the price in the requested currency.

See Also:

GetProductContractUnitPriceCmd.getBasePrice()

getCatEntryId

public java.lang.Long getCatEntryId()

Returns the id of the input catalog entry.

Returns:

The input catalog entry ID.

getCatEntryPrices

public CatEntryPrices[] getCatEntryPrices()

This method returns the price related information of the input catalog entries.

Specified by:

getCatEntryPrices in interface GetContractSpecialPriceCmd

Specified by:

getCatEntryPrices in interface GetContractUnitPriceCmd

Specified by:

getCatEntryPrices in interface GetEntitledPriceCmd

Specified by:

getCatEntryPrices in interface GetProductContractUnitPriceCmd

Returns:

an array of CatEntryPrices .

getCurrency

public java.lang.String getCurrency()
                             throws com.ibm.commerce.exception.ECSystemException

This method returns the currency of catalog entry. If currency is provided by caller the input will be returned, otherwise it returns a default currency of the store.

Specified by:

getCurrency in interface GetEntitledPriceCmd

Returns:

A currency value.

Throws:

com.ibm.commerce.exception.ECSystemException - If an error occurs when getting currency.

getOffer

public com.ibm.commerce.order.objects.OfferAccessBean getOffer()

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

getOffer in interface GetContractSpecialPriceCmd

Specified by:

getOffer in interface GetContractUnitPriceCmd

Specified by:

getOffer in interface GetProductContractUnitPriceCmd

Returns:

The offer access bean associated with the offer that was used to determine the best price, or null if no offer was used or GetContractUnitPriceCmd.getPrice() returns null.

See Also:

GetProductContractUnitPriceCmd.getOffer()

getOfferId

public java.lang.Long getOfferId()

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

getOfferId in interface GetContractSpecialPriceCmd

Specified by:

getOfferId in interface GetContractUnitPriceCmd

Specified by:

getOfferId in interface GetProductContractUnitPriceCmd

Returns:

The identifier of the offer that was used to determine the price, or null if no offer was used or GetContractUnitPriceCmd.getPrice() returns null.

See Also:

GetProductContractUnitPriceCmd.getOfferId()

getPrice

public MonetaryAmount getPrice()

This method returns the best price of the catalog entry.

Specified by:

getPrice in interface GetContractSpecialPriceCmd

Specified by:

getPrice in interface GetContractUnitPriceCmd

Specified by:

getPrice in interface GetEntitledPriceCmd

Specified by:

getPrice in interface GetProductContractUnitPriceCmd

Returns:

the price of the catalog entry Id.

getQuantity

public QuantityAmount getQuantity()
                           throws com.ibm.commerce.exception.ECSystemException

This method returns quantity of a catalog entry. If quantity is provided by caller, the input will be returned, otherwise it returns a default nominal quantity for input catalog entry.

Specified by:

getQuantity in interface GetEntitledPriceCmd

Returns:

A QuantityAmount that contains the quantity value and uom.

Throws:

com.ibm.commerce.exception.ECSystemException - If an error occurs when getting quantity.

getStoreId

public java.lang.Integer getStoreId()

Returns the store id.

Specified by:

getStoreId in interface com.ibm.commerce.command.ECCommand

Overrides:

getStoreId in class com.ibm.commerce.command.AbstractECTargetableCommand

Returns:

The store id from input or command context

getTcId

public java.lang.Long getTcId()

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

getTcId in interface GetContractSpecialPriceCmd

Specified by:

getTcId in interface GetContractUnitPriceCmd

Specified by:

getTcId in interface GetProductContractUnitPriceCmd

Returns:

The identifier of the term condition that was used to determine the best price. This value may be null if no term condition was used to determine the price or GetContractUnitPriceCmd.getPrice() returns null.

See Also:

GetProductContractUnitPriceCmd.getTcId()

getTradingId

public java.lang.Long getTradingId()

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

getTradingId in interface GetContractSpecialPriceCmd

Specified by:

getTradingId in interface GetContractUnitPriceCmd

Specified by:

getTradingId in interface GetProductContractUnitPriceCmd

Returns:

The identifier of the trading agreement that was used to determine the best price. This value may be null if no trading agreement was used to determine the price or GetContractUnitPriceCmd.getPrice() returns null.

See Also:

GetProductContractUnitPriceCmd.getTradingId()

performExecute

public void performExecute()
                    throws com.ibm.commerce.exception.ECException

This method executes main business logic of the command: Firstly, it normalizes input parameters and map catalog entry ID between catalog entry part number. Secondly, it uses input parameters to build GetPriceListType and calls external service. Thirdly, it resolves ShowPriceListDataAreaType returned from external service. Finally, it updates price memory cache using result.

Specified by:

performExecute in interface com.ibm.commerce.command.ECCommand

Overrides:

performExecute in class com.ibm.commerce.command.AbstractECTargetableCommand

Throws:

com.ibm.commerce.exception.ECException - If an error occurs when getting entitled price from external service.

reset

public void reset()

Resets the command.

Specified by:

reset in interface GetContractSpecialPriceCmd

Specified by:

reset in interface GetContractUnitPriceCmd

Specified by:

reset in interface GetProductContractUnitPriceCmd

Overrides:

reset in class com.ibm.commerce.command.AbstractECTargetableCommand

setCatEntryId

public void setCatEntryId(java.lang.Long aCatEntryId)

This method sets the Long value as input catalog entry ID.

Specified by:

setCatEntryId in interface GetContractSpecialPriceCmd

Specified by:

setCatEntryId in interface GetContractUnitPriceCmd

Specified by:

setCatEntryId in interface GetEntitledPriceCmd

Specified by:

setCatEntryId in interface GetProductContractUnitPriceCmd

Parameters:

aCatEntryId - The Long value which represents catalog entry ID.

setCatEntryPrices

public void setCatEntryPrices(CatEntryPrices[] aCatEntryPrices)

This method sets the information of one or more catalog entries using CatEntryPrices array.

Specified by:

setCatEntryPrices in interface GetContractSpecialPriceCmd

Specified by:

setCatEntryPrices in interface GetContractUnitPriceCmd

Specified by:

setCatEntryPrices in interface GetEntitledPriceCmd

Parameters:

aCatEntryPrices - The array of CatEntryPrices.

setCurrency

public void setCurrency(java.lang.String astrCurrency)

This method sets a currency which is used for finding the entitled price.

Specified by:

setCurrency in interface GetContractSpecialPriceCmd

Specified by:

setCurrency in interface GetContractUnitPriceCmd

Specified by:

setCurrency in interface GetEntitledPriceCmd

Specified by:

setCurrency in interface GetProductContractUnitPriceCmd

Parameters:

astrCurrency - The value which represents the currency value.

setErrorMode

public void setErrorMode(boolean aErrorMode)

Sets the flag to indicate if exception will be thrown when the price cannot be found

Specified by:

setErrorMode in interface GetContractSpecialPriceCmd

Specified by:

setErrorMode in interface GetContractUnitPriceCmd

Specified by:

setErrorMode in interface GetProductContractUnitPriceCmd

Parameters:

aErrorMode - The boolean value which indicates whether throwing exception when unsuccessfully retrieving best price. If it's true, the exception will be thrown.

setMemberId

public void setMemberId(java.lang.Long anMemberId)

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

setMemberId in interface GetContractUnitPriceCmd

Parameters:

anMemberId - The member identifier to be used to verify the input list of trading agreements. If null, the default value will be used.

See Also:

GetContractUnitPriceCmd.setMemberId(java.lang.Long)

setOfferIds

public void setOfferIds(java.lang.Long[] aOfferIds)

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

setOfferIds in interface GetContractSpecialPriceCmd

Specified by:

setOfferIds in interface GetContractUnitPriceCmd

Specified by:

setOfferIds in interface GetProductContractUnitPriceCmd

Parameters:

aOfferIds - The reference number of one or more offers that are to be used for determining the price. If null or empty, then the "best" of all qualifying offers will be used. Otherwise, the "best" of the specified offers will be returned.

See Also:

GetProductContractUnitPriceCmd.setOfferIds(java.lang.Long[])

setOrderItemAccessBean

public void setOrderItemAccessBean(com.ibm.commerce.order.objects.OrderItemAccessBean aOrderItemAccessBean)

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

setOrderItemAccessBean in interface GetContractSpecialPriceCmd

Parameters:

aOrderItemAccessBean - An order item access bean. May be null.

See Also:

GetContractSpecialPriceCmd.setOrderItemAccessBean(com.ibm.commerce.order.objects.OrderItemAccessBean)

setOrganizationId

public void setOrganizationId(java.lang.Long anOrganizationId)

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

setOrganizationId in interface GetContractUnitPriceCmd

Parameters:

anOrganizationId - The organization identifier to be used in conjunction with the member identifier to verify the input list of trading agreements. If null, the default value will be used.

See Also:

GetContractUnitPriceCmd.setOrganizationId(java.lang.Long)

setQuantity

public void setQuantity(QuantityAmount aQuantityAmount)

Sets the quantity amount of the input catalog entry that is to be priced.

Specified by:

setQuantity in interface GetContractSpecialPriceCmd

Specified by:

setQuantity in interface GetContractUnitPriceCmd

Specified by:

setQuantity in interface GetEntitledPriceCmd

Specified by:

setQuantity in interface GetProductContractUnitPriceCmd

Parameters:

aQuantityAmount - the quantity

setStoreId

public void setStoreId(java.lang.Integer aStoreId)

Sets the id of the input store to be used for calculating the price .

Specified by:

setStoreId in interface GetContractSpecialPriceCmd

Specified by:

setStoreId in interface GetContractUnitPriceCmd

Specified by:

setStoreId in interface GetEntitledPriceCmd

Specified by:

setStoreId in interface GetProductContractUnitPriceCmd

Parameters:

aStoreId - the store ID

setTradingIds

public void setTradingIds(java.lang.Long[] aTradingIds)

This method, inherited from the parent class, is not supported for integration with an external price management system.

Specified by:

setTradingIds in interface GetContractSpecialPriceCmd

Specified by:

setTradingIds in interface GetContractUnitPriceCmd

Specified by:

setTradingIds in interface GetProductContractUnitPriceCmd

Parameters:

aTradingIds - The identifiers of the trading agreements to be used to determine the prices. If null or empty, the current or entitled trading agreements will be used as described above.

See Also:

GetProductContractUnitPriceCmd.setTradingIds(java.lang.Long[])

validateParameters

public void validateParameters()
                        throws com.ibm.commerce.exception.ECException

This method performs server side parameter checking, validates the mandatory parameters. The consumer of this command must provide either a catEntry ID or catEntryPrices

Specified by:

validateParameters in interface com.ibm.commerce.command.ECCommand

Overrides:

validateParameters in class com.ibm.commerce.command.AbstractECTargetableCommand

Throws:

com.ibm.commerce.exception.ECException - If an error occurs when validating parameters.