java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.TaskCommandImpl | +--com.ibm.commerce.command.BusinessPolicyCommandImpl | +--com.ibm.commerce.payment.commands.DoPaymentCLCmdImpl
This
DoPaymentPolicy
business policy command implementation class
is the default implementation class for authorizing payment that specify the
"Credit" Payment Policy.
Parameter:
Parameter Name | Type | Descriptions |
abOrder | OrderAccessBean | The Order ID of the Order |
bdTotalAmount | BigDecimal | The Total Amount to be authorized |
nPolicyId | Long | The ID of the Payment Policy to use for the Purchase. |
nBuyerPOId | Long | Optional buyerPOId |
errorViewName | String | Optional error view name passed in by the Caller. |
PaymentConstants.ERR_CODE_CREDIT_LINE_NOT_AVAILABLE
(1981) -
Credit Line not available or no longer active.
Field Summary |
---|
Fields inherited from class com.ibm.commerce.command. BusinessPolicyCommandImpl |
policyId,
requestProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.payment.commands. DoPaymentPolicyCmd |
CC_VALID_Y_RANGE,
COPYRIGHT,
defaultCommandClassName,
ERRTASK_NAME,
MESSAGE_FOR_BUYER,
NAME,
NVP_field,
NVP_FIELD,
PM_MESSAGE_FOR_BUYER,
PM_MESSAGE_FOR_MERCHANT,
PM_PRIMARY_RC,
PM_SECONDARY_RC,
WCSHOSTNAME,
WCSWEBSERVERPORT,
WEBPATH |
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand |
COPYRIGHT |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Constructor Summary | |
---|---|
DoPaymentCLCmdImpl() |
Method Summary | |
---|---|
protected
AccountAccessBean |
getAccount() Returns the AccountAccessBean representing the Account associated with the order. |
protected
java.lang.Long |
getAccountId() Returns the account ID of the Account associated with the order. |
protected
java.lang.Long |
getBuyerPOId() Returns the internal ID of the BuyerPO record if a buyer purchase order number is specified. |
java.lang.String |
getContentType() Returns the Content Type (or MIME type) of the return data, or null if the type is not known. |
protected
java.lang.Long |
getCreditLineId() Returns the internal ID of the CreditLine record representing the credit line the account holder (buyer organization) has with the seller. |
protected
java.lang.String |
getErrorViewName() Returns the name of the error view to use for reporting error. |
protected
OrderAccessBean |
getOrder() Returns the OrderAccessBean representing the order being processed. |
java.lang.String |
getOrderState() Returns the single character String value that the called command wants the Calling command to use to set the Status of the order. |
protected
TypedProperty |
getPaymentAttributes() Returns the TypedProperty object containing the payment attributes passed to this command by the calling command. |
byte[] |
getReturnData() Returns the byte Array containing Return Data from the Payment System. |
protected
java.math.BigDecimal |
getTotalAmount() Returns the total order amount passed to the command by the caller. |
boolean |
isReadyToCallExecute() This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. |
void |
performExecute() Performs the main business logic of the command. |
void |
reset() Resets the instance variables of the command. |
void |
setAccount(
AccountAccessBean abAccount) Sets the account property of the command. |
void |
setBuyerPOId(java.lang.Long n) Sets the optional buyerPOId if the customer (buyer) had specified a buyer purchase order number. |
protected
void |
setCreditLineId(java.lang.Long n) Sets the internal ID of the CreditLine record representing the credit line the account holder (buyer organization) has with the seller. |
void |
setErrorViewName(java.lang.String sEVN) Sets the error view to be used to report error. |
void |
setOrder(
OrderAccessBean ab) Sets the order property of the command. |
void |
setOrderState(java.lang.String s) Sets the order state to be returned to the caller. |
void |
setPaymentAttributes(
TypedProperty paymentAttributes) Sets the paymentAttributes property of the command. |
void |
setTotalAmount(java.math.BigDecimal totalAmount) Sets the totalAmount property of the command. |
protected
void |
updateOrderPaymentMethod() This is called by performExecute to update the ORDPAYMTHD table. |
Methods inherited from class com.ibm.commerce.command. BusinessPolicyCommandImpl |
getPolicyId,
getRequestProperties,
setPolicyId,
setRequestProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties,
validateParameters |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. BusinessPolicyCommand |
getPolicyId,
getRequestProperties,
setPolicyId,
setRequestProperties |
Constructor Detail |
---|
public DoPaymentCLCmdImpl()
Method Detail |
---|
protected AccountAccessBean getAccount()
protected java.lang.Long getAccountId() throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException
java.rmi.RemoteException
protected java.lang.Long getBuyerPOId()
public java.lang.String getContentType()
null
if the type is not known.
getContentType
in interface
DoPaymentPolicyCmd
String
containing the name of the MIME type of the return
data, or null if the type is not known. Since this command implementation does
not have return data, the method returns null
.protected java.lang.Long getCreditLineId()
protected java.lang.String getErrorViewName()
protected OrderAccessBean getOrder()
public java.lang.String getOrderState()
getOrderState
in interface
DoPaymentPolicyCmd
protected TypedProperty getPaymentAttributes()
public byte[] getReturnData()
getReturnData
in interface
DoPaymentPolicyCmd
protected java.math.BigDecimal getTotalAmount()
public boolean isReadyToCallExecute()
isReadyToCallExecute
in class
AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
public void reset()
This is useful if the command instance is to be called multiple times with different command parameters.
reset
in class
AbstractECTargetableCommand
public void setAccount(AccountAccessBean abAccount)
setAccount
in interface
DoPaymentPolicyCmd
abAccount
- the AccountAccessBean representing the account the
order is associated withpublic void setBuyerPOId(java.lang.Long n)
setBuyerPOId
in interface
DoPaymentPolicyCmd
n
- the internal ID of the BuyerPO record representing the
purchase order number specifiedprotected void setCreditLineId(java.lang.Long n)
n
- the internal ID of the CreditLine
recordpublic void setErrorViewName(java.lang.String sEVN)
setErrorViewName
in interface
DoPaymentPolicyCmd
sEVN
- the Error View nameERRTASK_NAME
public void setOrder(OrderAccessBean ab)
setOrder
in interface
DoPaymentPolicyCmd
ab
- the OrderAccessBean representing the order for which
payment is to be processedpublic void setOrderState(java.lang.String s)
public void setPaymentAttributes(TypedProperty paymentAttributes)
setPaymentAttributes
in interface
DoPaymentPolicyCmd
paymentAttributes
- the TypedProperty object that contains all
the command parameters to be passed to this command.public void setTotalAmount(java.math.BigDecimal totalAmount)
setTotalAmount
in interface
DoPaymentPolicyCmd
totalAmount
- the total price of the Order for which payment
is to be processed.protected void updateOrderPaymentMethod() throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException
java.rmi.RemoteException