com.ibm.commerce.payment.commands

Interface UpdatePOSpendingCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

UpdatePOSpendingForLimitCheckCmdImpl

public interface UpdatePOSpendingCmd
extends TaskCommand

This task command is used to update Purchase Order's Spending for the given order and buyerPurchaseOrder. The default implementation of this command is UpdatePOSpendingForLimitCheckCmdImpl.

Parameters:

Parameter Name	Type	Descriptions
order	OrderAccessBean	The OrderAccessBean of the order
buyerPurchaseOrder	BuyerPurchaseOrderAccessBean	The BuyerPurchaseOrderAccessBean representing the buyer purchase order record.
totalAmount	BigDecimal	The Total Amount to be recorded. This amount is in the currency of the order.
errorViewName	String	Optional error view name passed in by the Caller.

Behavior:

• The default implementation inserts a row into the LPOPURAMT Table if the purchase was done specifying a Limited Purchase Order. (No row is created if the Purchase Order specified is NOT a Limited Purchase Order.)
• Throws an ECApplicationException if the purchase amount exceeds the Purchase Order spending limits specified via a PurchaseOrderTC for Limited Purchase Order.
• The purchase was made using a currency that is different from the currency specified for the Limited Purchase Order. The total amount will be converted to the purchase order currency before storing it in the LPOPURAMT Table.
• Since this Task Command may be called more than once, skip the insert if the row already exists.
• The Total Purchase Amount of the Limited Purchase Order is not decremented if a Refund is issued later against the Order.

Default Error View Name:

• UpdatePOSpendingErrorView (This is the default Error View Name if none is passed in by the Calling command.)

ErrorCodes:

• PaymentConstants.ERR_CODE_CURRENCY_CONVERT_FAIL (1961) - Currency conversion not available or failed.
• PaymentConstants.ERR_CODE_PURCHASE_AMOUNT_EXCEED_LIMIT_OF_LPO (1964) - Purchase Amount Exceeded the Spending Limit (Amount) of the Limited PO.

See Also:

UpdatePOSpendingForLimitCheckCmdImpl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation of this command.
static java.lang.String	ERRTASK_NAME The name of the default error view for this command.
static java.lang.String	NAME The full name of this command.

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	setBuyerPurchaseOrder(BuyerPurchaseOrderAccessBean abBPOA) This method specifies the BuyerPurchaseOrderAccessBean representing the Purchase Order specified for the purchase.
void	setErrorViewName(java.lang.String sEVN) This method sets the error view to be used to report error.
void	setOrder(OrderAccessBean abOrder) This method sets the order property of the command.
void	setTotalAmount(java.math.BigDecimal nTA) This method sets the totalAmount property of the command.

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

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

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

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

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The full name of this command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

ERRTASK_NAME

static final java.lang.String ERRTASK_NAME

The name of the default error view for this command. The constant value of this field is "UpdatePOSpendingBalanceErrorView".

See Also:

Constant Field Values

Method Detail

setBuyerPurchaseOrder

void setBuyerPurchaseOrder(BuyerPurchaseOrderAccessBean abBPOA)

This method specifies the BuyerPurchaseOrderAccessBean representing the Purchase Order specified for the purchase.

Parameters:

abBPOA - A BuyerPurchaseOrderAccessBean that represents the buyer purchase order.

setErrorViewName

void setErrorViewName(java.lang.String sEVN)

This method sets the error view to be used to report error. This overrides the default error view of the command.

Parameters:

sEVN - The Error View name.

setOrder

void setOrder(OrderAccessBean abOrder)

This method sets the order property of the command.

Parameters:

abOrder - The OrderAccessBean of the Order.

setTotalAmount

void setTotalAmount(java.math.BigDecimal nTA)

This method sets the totalAmount property of the command.

Parameters:

nTA - A BigDecimal that specific the total amount for the purchase order spending limit record update.