com.ibm.commerce.payment.commands
Class DoPaymentCLCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.command.BusinessPolicyCommandImpl
                    |
                    +--com.ibm.commerce.payment.commands.DoPaymentCLCmdImpl
All Implemented Interfaces:
BusinessPolicyCommand, DoPaymentPolicyCmd, ECCommand, TaskCommand

public class DoPaymentCLCmdImpl
extends BusinessPolicyCommandImpl
implements DoPaymentPolicyCmd

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.

Behavior:

Returned Parameters: Error View Name: ErrorCodes:


Fields inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
policyId, requestProperties
 
Fields inherited from class com.ibm.commerce.command.AbstractECCommand
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, PM_MESSAGE_FOR_BUYER, PM_MESSAGE_FOR_MERCHANT, PM_PRIMARY_RC, PM_SECONDARY_RC, WCSHOSTNAME, WCSWEBSERVERPORT, WEBPATH
 
Constructor Summary
DoPaymentCLCmdImpl()
           
 
Method Summary
protected  AccountAccessBean getAccount()
          This returns the Account Access Bean.
protected  java.lang.Long getAccountId()
          This returns the Account ID.
protected  java.lang.Long getBuyerPOId()
          This returns the Buyer Purchase Order ID.
 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()
           
protected  java.lang.String getErrorViewName()
          Retrieve the error view name passed in by the Caller.
protected  OrderAccessBean getOrder()
          This returns the Order Access Bean.
 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()
           
 byte[] getReturnData()
          Returns the byte Array containing Return Data from the Payment System.
protected  java.math.BigDecimal getTotalAmount()
           
 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 abAccount property of the command.
 void setBuyerPOId(java.lang.Long n)
          Set Optional buyerPOId.
protected  void setCreditLineId(java.lang.Long n)
           
 void setErrorViewName(java.lang.String sEVN)
          Optional error view name passed in by the Caller.
 void setOrder(OrderAccessBean ab)
          The order to be ReApproved.
 void setOrderState(java.lang.String s)
           
 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 ORDPAYMTHD table with refund info
 
Methods inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, 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
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Constructor Detail

DoPaymentCLCmdImpl

public DoPaymentCLCmdImpl()
Method Detail

getAccount

protected AccountAccessBean getAccount()
This returns the Account Access Bean.

getAccountId

protected java.lang.Long getAccountId()
                               throws javax.ejb.CreateException,
                                      javax.ejb.FinderException,
                                      javax.naming.NamingException,
                                      java.rmi.RemoteException
This returns the Account ID.

getBuyerPOId

protected java.lang.Long getBuyerPOId()
This returns the Buyer Purchase Order ID.

getContentType

public java.lang.String getContentType()
Returns the Content Type (or MIME type) of the return data, or null if the type is not known.
Specified by:
getContentType in interface DoPaymentPolicyCmd
Returns:
a 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.

getCreditLineId

protected java.lang.Long getCreditLineId()

getErrorViewName

protected java.lang.String getErrorViewName()
Retrieve the error view name passed in by the Caller.

getOrder

protected OrderAccessBean getOrder()
This returns the Order Access Bean.

getOrderState

public 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. If the returned String is empty or null, the Calling command will decide the value to use for the Status
Specified by:
getOrderState in interface DoPaymentPolicyCmd
Returns:
java.lang.String

getPaymentAttributes

protected TypedProperty getPaymentAttributes()

getReturnData

public byte[] getReturnData()
Returns the byte Array containing Return Data from the Payment System. The Payment System used by this command does not use Return Data. Therefore return null.
Specified by:
getReturnData in interface DoPaymentPolicyCmd
Returns:
byte[]

getTotalAmount

protected java.math.BigDecimal getTotalAmount()

isReadyToCallExecute

public boolean isReadyToCallExecute()
This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. This is done before the Framework calls the performExecute method of the command.
Overrides:
isReadyToCallExecute in class AbstractECCommand
Following copied from class: com.ibm.commerce.command.AbstractECCommand
Returns:
boolean - true if we can execute the command false if we canot execute the command

performExecute

public void performExecute()
                    throws ECException
Performs the main business logic of the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

reset

public void reset()
Resets the instance variables of the command. The reset() method will reset all instance variables. If the command includes any output values that are accessible via getters, then make sure those values are no longer needed before calling this method to reset the instance variables of the command.

This is useful if the command instance is to be called multiple times with different command parameters.

Overrides:
reset in class AbstractECCommand

setAccount

public void setAccount(AccountAccessBean abAccount)
Description copied from interface: DoPaymentPolicyCmd
Sets the abAccount property of the command.
Specified by:
setAccount in interface DoPaymentPolicyCmd
Following copied from interface: com.ibm.commerce.payment.commands.DoPaymentPolicyCmd
Parameters:
abAccount - the AccountAccessBean of the Order is associated with

setBuyerPOId

public void setBuyerPOId(java.lang.Long n)
Set Optional buyerPOId.
Specified by:
setBuyerPOId in interface DoPaymentPolicyCmd
Following copied from interface: com.ibm.commerce.payment.commands.DoPaymentPolicyCmd
Parameters:
nBuyerPOId - the Buyer Purchase Order Reference Number of the Order is associated with

setCreditLineId

protected void setCreditLineId(java.lang.Long n)

setErrorViewName

public void setErrorViewName(java.lang.String sEVN)
Optional error view name passed in by the Caller.
Specified by:
setErrorViewName in interface DoPaymentPolicyCmd

setOrder

public void setOrder(OrderAccessBean ab)
The order to be ReApproved.
Specified by:
setOrder in interface DoPaymentPolicyCmd
Following copied from interface: com.ibm.commerce.payment.commands.DoPaymentPolicyCmd
Parameters:
abOrder - the OrderAccessBean of the Order for which payment is to be processed.

setOrderState

public void setOrderState(java.lang.String s)

setPaymentAttributes

public void setPaymentAttributes(TypedProperty paymentAttributes)
Sets the paymentAttributes property of the command.
Specified by:
setPaymentAttributes in interface DoPaymentPolicyCmd
Parameters:
requestProperties - the requestProperties object that contains all the command parameters are to be passed to this command.

setTotalAmount

public void setTotalAmount(java.math.BigDecimal totalAmount)
Sets the totalAmount property of the command.
Specified by:
setTotalAmount in interface DoPaymentPolicyCmd
Parameters:
totalAmount - the total price of the Order for which payment is to be processed.

updateOrderPaymentMethod

protected void updateOrderPaymentMethod()
                                 throws javax.ejb.CreateException,
                                        javax.ejb.FinderException,
                                        javax.naming.NamingException,
                                        java.rmi.RemoteException
This is called by performExecute to update ORDPAYMTHD table with refund info