com.ibm.commerce.payment.commands
Class DoPaymentMPFCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.payment.commands.DoPaymentMPFCmdImpl
All Implemented Interfaces:
DoInventory, DoPaymentCmd, ECCommand, TaskCommand

public class DoPaymentMPFCmdImpl
extends TaskCommandImpl
implements DoPaymentCmd, DoInventory

Default DoPayment task command implementation.

Parameter:
Parameter Name Type Descriptions
orderId Long The ID of the Order
totalAmount BigDecimal The Total Amount to be authorized
policyId Long The ID of the Payment Policy to use for the Purchase.
tcId Long The ID of the Payment Term and Condition to use for the Purchase.
paymentAttributes TypedProperty The payment attributes (eor example,.g. all the name-value pairs from the OrderProcess command)

Note: If any of the Trading Agreement used by Order Items of the Order has Payment Terms and Conditions, then tcId is mandatory. If tcId is specified, policyId is ignored. The UsablePaymentTCListDataBean may be used to return a list of PaymentTCInfo beans representing common Payment Terms and Conditions specified by Trading Agreements used. If the none of the Trading Agreement has Payment Terms and Conditions, the DataBean returns PaymentTCInfo beans with the tcId attributes set to the empty string. In that case, the PaymentTCInfo beans represent Payment Policies supported by the Store. @see UsablePaymentTCListDataBean.

Behavior:

Returned Parameters: Error View Name: ErrorCodes:


Field Summary
static java.lang.String APPROVAL_AMOUNT
           
static java.lang.String BILLTO_ADDRESS1
           
static java.lang.String BILLTO_ADDRESS2
           
static java.lang.String BILLTO_CITY
           
static java.lang.String BILLTO_COUNTRY
           
static java.lang.String BILLTO_COUNTRY_CODE
           
static java.lang.String BILLTO_EMAIL_ADDR1
           
static java.lang.String BILLTO_FIRSTNAME
           
static java.lang.String BILLTO_LASTNAME
           
static java.lang.String BILLTO_MIDDLENAME
           
static java.lang.String BILLTO_PHONE_NUMBER
           
static java.lang.String BILLTO_STATE
           
static java.lang.String BILLTO_ZIPCODE
           
static java.lang.String BUYER_LANGUAGE_ID
           
static java.lang.String CARD_EXPIRY
           
static java.lang.String CARD_NUMBER
           
static java.lang.String CURRENCY_ALPHA_CODE
           
static java.lang.String CURRENCY_FACTOR
           
static java.lang.String LANGUAGE_ENCODING
           
static java.lang.String PAYMTHD_PSRVR
           
static java.lang.String PAYMTHD_SET
           
static int PRC_DUPLICATE_OBJECT
           
static int SRC_CONNECTION_TO_PM_FAILED
           
static int SRC_INITIALIZATION_MESSAGE
           
static int SRC_ORDER
           
static int SRC_USER_NOT_AUTHORIZED
           
static java.lang.String TOTAL_SHIPPING_AMOUNT
           
static java.lang.String TOTAL_TAX_AMOUNT
           
 
Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.commands.DoPaymentCmd
CC_VALID_Y_RANGE, COPYRIGHT, defaultCommandClassName, ERR_CODE_BAD_CCNUM, ERR_CODE_BAD_SYS, ERR_CODE_BAD_XDATE, ERR_CODE_MISSING_PARAM, 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
DoPaymentMPFCmdImpl()
           
 
Method Summary
protected  AccountAccessBean getAccount()
          Returns the AccountAccessBean representing the Account if an Account ID is set.
protected  java.lang.Long getAccountId()
          Returns the common Account ID if one is specified by the Trading Agreements used by the Order items of the Order being processed.
protected  java.lang.Long getBuyerPOId()
          Returns the internal BuyerPO ID of the Buyer PONumber if it 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  OrderAccessBean getOrder()
          Returns the OrderAccessBean representing the Order.
protected  java.lang.Long getOrderId()
          Returns the Order ID of the Order.
 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.
protected  java.lang.Integer getPaymentMethodId()
          Returns the payMethodId attribute passed to the command by the caller.
protected  java.lang.Long getPolicyId()
          Returns the payMethodId attribute passed to the command by the caller.
protected  java.lang.String getPONumber()
          Returns the PONumber attribute passed to the command by the caller.
 byte[] getReturnData()
          Returns the byte Array containing Return Data from the Payment Manager.
protected  java.lang.String getTcId()
          Returns the tcId attribute passed to the command by the caller.
protected  java.math.BigDecimal getTotalAmount()
          Returns the totalAmount attribute 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.
protected  void setAccountId(java.lang.Long n)
           
protected  void setBuyerPOId(java.lang.Long n)
          Sets the buyerPOId.
protected  void setContentType(java.lang.String sContentType)
           
 void setOrderId(java.lang.Long orderId)
          Sets the orderId property of the command.
protected  void setOrderState(java.lang.String orderState)
           
 void setPaymentAttributes(TypedProperty paymentAttributes)
          Sets the paymentAttributes property of the command.
 void setPaymentMethodId(java.lang.Integer nPayMthdId)
           
 void setPolicyId(java.lang.Long n)
          Sets the policyId property of the command.
protected  void setPONumber(java.lang.String sPONumber)
           
protected  void setReturnData(byte[] ba)
           
protected  void setTcId(java.lang.String s)
          Sets the tcId property of the command.
 void setTotalAmount(java.math.BigDecimal totalAmount)
          Sets the totalAmount property of the command.
 
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.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

APPROVAL_AMOUNT

public static final java.lang.String APPROVAL_AMOUNT

BILLTO_ADDRESS1

public static final java.lang.String BILLTO_ADDRESS1

BILLTO_ADDRESS2

public static final java.lang.String BILLTO_ADDRESS2

BILLTO_CITY

public static final java.lang.String BILLTO_CITY

BILLTO_COUNTRY

public static final java.lang.String BILLTO_COUNTRY

BILLTO_COUNTRY_CODE

public static final java.lang.String BILLTO_COUNTRY_CODE

BILLTO_EMAIL_ADDR1

public static final java.lang.String BILLTO_EMAIL_ADDR1

BILLTO_FIRSTNAME

public static final java.lang.String BILLTO_FIRSTNAME

BILLTO_LASTNAME

public static final java.lang.String BILLTO_LASTNAME

BILLTO_MIDDLENAME

public static final java.lang.String BILLTO_MIDDLENAME

BILLTO_PHONE_NUMBER

public static final java.lang.String BILLTO_PHONE_NUMBER

BILLTO_STATE

public static final java.lang.String BILLTO_STATE

BILLTO_ZIPCODE

public static final java.lang.String BILLTO_ZIPCODE

BUYER_LANGUAGE_ID

public static final java.lang.String BUYER_LANGUAGE_ID

CARD_EXPIRY

public static final java.lang.String CARD_EXPIRY

CARD_NUMBER

public static final java.lang.String CARD_NUMBER

CURRENCY_ALPHA_CODE

public static final java.lang.String CURRENCY_ALPHA_CODE

CURRENCY_FACTOR

public static final java.lang.String CURRENCY_FACTOR

LANGUAGE_ENCODING

public static final java.lang.String LANGUAGE_ENCODING

PAYMTHD_PSRVR

public static final java.lang.String PAYMTHD_PSRVR

PAYMTHD_SET

public static final java.lang.String PAYMTHD_SET

PRC_DUPLICATE_OBJECT

public static final int PRC_DUPLICATE_OBJECT

SRC_CONNECTION_TO_PM_FAILED

public static final int SRC_CONNECTION_TO_PM_FAILED

SRC_INITIALIZATION_MESSAGE

public static final int SRC_INITIALIZATION_MESSAGE

SRC_ORDER

public static final int SRC_ORDER

SRC_USER_NOT_AUTHORIZED

public static final int SRC_USER_NOT_AUTHORIZED

TOTAL_SHIPPING_AMOUNT

public static final java.lang.String TOTAL_SHIPPING_AMOUNT

TOTAL_TAX_AMOUNT

public static final java.lang.String TOTAL_TAX_AMOUNT
Constructor Detail

DoPaymentMPFCmdImpl

public DoPaymentMPFCmdImpl()
Method Detail

getAccount

protected AccountAccessBean getAccount()
Returns the AccountAccessBean representing the Account if an Account ID is set. If no Account ID is set, null is returned.

This method will first check if the local variable iabAccount is set. If not set, it will attempt to retrieve the AccountAccessBean using the specified Account ID.


getAccountId

protected java.lang.Long getAccountId()
Returns the common Account ID if one is specified by the Trading Agreements used by the Order items of the Order being processed. If there is no Account ID, null is returned.

getBuyerPOId

protected java.lang.Long getBuyerPOId()
Returns the internal BuyerPO ID of the Buyer PONumber if it is specified. Otherwise returns a null.

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 DoPaymentCmd
Returns:
a String containing the name of the MIME type of the return data, or null if the type is not known

getOrder

protected OrderAccessBean getOrder()
Returns the OrderAccessBean representing the Order.

This method will first check if the local variable is set or not. If not set it will attempt to get it by create a new AccessBean.


getOrderId

protected java.lang.Long getOrderId()
Returns the Order ID of the Order.

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 null, the Calling command will decide the value to use for the Status
Specified by:
getOrderState in interface DoPaymentCmd
Returns:
java.lang.String

getPaymentAttributes

protected TypedProperty getPaymentAttributes()
Returns the TypedProperty object containing the payment attributes passed to this command by the calling command.

getPaymentMethodId

protected java.lang.Integer getPaymentMethodId()
Returns the payMethodId attribute passed to the command by the caller.
See Also:
setPaymentAttributes.

getPolicyId

protected java.lang.Long getPolicyId()
Returns the payMethodId attribute passed to the command by the caller.
See Also:
setPaymentAttributes.

getPONumber

protected java.lang.String getPONumber()
Returns the PONumber attribute passed to the command by the caller.

getReturnData

public byte[] getReturnData()
Returns the byte Array containing Return Data from the Payment Manager. This method returns a zero length byte array if there is no rturn data from the Payment Manager.
Specified by:
getReturnData in interface DoPaymentCmd
Returns:
byte[]

getTcId

protected java.lang.String getTcId()
Returns the tcId attribute passed to the command by the caller.
See Also:
setPaymentAttributes.

getTotalAmount

protected java.math.BigDecimal getTotalAmount()
Returns the totalAmount attribute passed to the command by the caller.
See Also:
setPaymentAttributes.

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

setAccountId

protected void setAccountId(java.lang.Long n)

setBuyerPOId

protected void setBuyerPOId(java.lang.Long n)
Sets the buyerPOId. This ID is the internal ID of the record representing the buyerPO.

setContentType

protected void setContentType(java.lang.String sContentType)

setOrderId

public void setOrderId(java.lang.Long orderId)
Sets the orderId property of the command.
Specified by:
setOrderId in interface DoPaymentCmd
Parameters:
orderId - the order reference number of the Order for which payment is to be processed.

setOrderState

protected void setOrderState(java.lang.String orderState)

setPaymentAttributes

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

Some of the Payment Attributes that may be passed to the command are:

       Keyword                         Value
     ===========        ====================================
     tcId               ID of the Payment Term and Condition to use
     policyId           ID of the Payayment Policy to use.
     payMethodId        PayMthd_Id of the Cashier Profile to use
     cardBrand          The credit card brand.
     cardNumber         The credit card number              
     cardExpiryMonth    The credit card exipration month  
     cardExpiryYear     The credit card exipration year   
 

The first three attributes (tcId, policyId and payMethodId) determines how the payment is to be processed. At least one of the three must be specified and tcId is mandatory if any of the Order items of the Order uses a Trading Agreement that includes Payment Terms and Conditions.

If tcId is specified, policyId and payMethodId are ignored. If tcId is not specified, either policyId or payMethodId must be specified. If policyId is specified, payMethodId is ignored.

The payMethodId attribute is for backward compatibility only. This attribute will only have effect if neither the icId and policyId attributes are present. See the WebSphere Commerce Migration Guide for information.

The cardBrand and cardNumber attributes, if specified, must both be present. Same is true for the cardExpiryMonth and the cardExpiryYear attributes. (The cardBrand attribute must match the BrandID used to configure the Merchant Account if Payment Manager is used. The BrandID is case-sensitive.)

Note: other payment attributes may be specified dependent on the payment method used to process the payment.


setPaymentMethodId

public void setPaymentMethodId(java.lang.Integer nPayMthdId)

setPolicyId

public void setPolicyId(java.lang.Long n)
Sets the policyId property of the command.
Parameters:
n - The ID of the Payment Policy to be used to process payment for this Order.

setPONumber

protected void setPONumber(java.lang.String sPONumber)

setReturnData

protected void setReturnData(byte[] ba)

setTcId

protected void setTcId(java.lang.String s)
Sets the tcId property of the command.
Parameters:
s - The ID of the Payment Term and Condition to be used to process payment for this Order.

setTotalAmount

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