PrimePaymentCmdImpl
public class DoPaymentMPFCmdImpl extends TaskCommandImpl implements DoPaymentCmd, DoInventory
DoPayment
task command implementation.
Parameters:
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. |
paymentMethodId | Integer | Deprecated.The ID of the Cashier Profile to use, only for backward compatibility, This attribute will have no effect |
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.
Behavior:
CheckPaymentAccept
instead and skip the rest
AuthorizeAccountPayment
Task command to see if the Account will accept the charges.
CheckTASpendingLimit
Task command to see if Spending Amount exceeds Limit specified in the Trading Agreement. (Calls this Task Command regardless of the presence of RightToBuyTC by Amount in the Trading Agreement.)
ValidatePONumber
Task command to validate the PO Number if buyerPONumber is specified as one of the paymentAttributes and the common Account ID (of the all the Trading Agreements) is not null.
CheckPOSpendingLimit
Task command to see if the SpendingLimit specified in Limited PO will be exceeded (if a Limited PO is specified for the purchase).
DoPaymentPolicy
command for the Payment Policy specified for the Purchase.
Returned Parameters:
Error View Name:
ErrorCodes:
This command uses the following AccessBeans:
AccountAccessBean
BusinessPolicyAccessBean
BuyerPurchaseOrderAccessBean
OrderAccessBean
OrderItemAccessBean
TradingAgreementAccessBean
TermConditionAccessBean
StoreAccessBean
This command calls the following TaskCommands:
AuthorizeAccountPaymentCmd
CheckPaymentAcceptCmd
CheckPOSpendingLimitCmd
CheckTASpendingLimitCmd
ValidatePONumberCmd
This command calls the following BusinessPolicyCommands:
UsablePaymentTCListDataBean
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
APPROVAL_AMOUNT
Deprecated.
Environment variable name for the approval amount parameter.
|
static java.lang.String |
BILLTO_ADDRESS1
Deprecated.
Environment variable name for the address line 1 field of the billto address.
|
static java.lang.String |
BILLTO_ADDRESS2
Deprecated.
Environment variable name for the address line 2 field of the billto address.
|
static java.lang.String |
BILLTO_CITY
Deprecated.
Environment variable name for the city field in the billto address.
|
static java.lang.String |
BILLTO_COUNTRY
Deprecated.
Environment variable name for the country field in the billto address.
|
static java.lang.String |
BILLTO_COUNTRY_CODE
Deprecated.
Environment variable name for the country code field in the billto address.
|
static java.lang.String |
BILLTO_EMAIL_ADDR1
Deprecated.
Environment variable name for the email address 1 field of the billto address.
|
static java.lang.String |
BILLTO_FIRSTNAME
Deprecated.
Environment variable name for the first name of the recipient in the billto address.
|
static java.lang.String |
BILLTO_LASTNAME
Deprecated.
Environment variable name for the last name of the recipient in the billto address.
|
static java.lang.String |
BILLTO_MIDDLENAME
Deprecated.
Environment variable name for the middle name of the recipient in the billto address.
|
static java.lang.String |
BILLTO_PHONE_NUMBER
Deprecated.
Environment variable name for the phone number field of the billto address.
|
static java.lang.String |
BILLTO_STATE
Deprecated.
Environment variable name for the state or province field in the billto address.
|
static java.lang.String |
BILLTO_ZIPCODE
Deprecated.
Environment variable name for the zip code or postal code field in the billto address.
|
static java.lang.String |
BUYER_LANGUAGE_ID
Deprecated.
Environment variable name for the buyer language ID.
|
static java.lang.String |
CARD_EXPIRY
Deprecated.
Environment variable name for the card expiry date parameter.
|
static java.lang.String |
CARD_NUMBER
Deprecated.
Environment variable name for the card number parameter.
|
static java.lang.String |
CURRENCY_ALPHA_CODE
Deprecated.
Environment variable name for the alpha currency code.
|
static java.lang.String |
CURRENCY_FACTOR
Deprecated.
Environment variable name for the currency factor parameter.
|
static java.lang.String |
LANGUAGE_ENCODING
Deprecated.
Environment variable name for the language encoding parameter.
|
static java.lang.String |
PAYMTHD_PSRVR
Deprecated.
Constant value used to populate the ORDPAYMTHD.PAYMETHOD field to indicate that the
order has been submitted to WebSphere Commerce Payments for processing.
|
static java.lang.String |
PAYMTHD_SET
Deprecated.
Constant value once used by the predecessor product of WebSphere Commerce to populate
the ORDPAYMTHD.PAYMETHOD field to indicate that the payment for the order was
processed by the payment cassette for SET.
|
static int |
PRC_DUPLICATE_OBJECT
Deprecated.
The WebSphere Commerce Payments primary return code for a duplicate object error.
|
static int |
PRC_VALUE_ERROR
Deprecated.
The WebSphere Commerce Payments primary return code for a duplicate object error.
|
static int |
SRC_AMOUNT
Deprecated.
The WebSphere Commerce Payments secondary return code indicating that the error is
referring to the amount field.
|
static int |
SRC_CONNECTION_TO_PM_FAILED
Deprecated.
The WebSphere Commerce Payments secondary return code indicating that there was a
communication failure.
|
static int |
SRC_INITIALIZATION_MESSAGE
Deprecated.
The WebSphere Commerce Payments secondary return code indicating an initialization
message is included in the response.
|
static int |
SRC_ORDER
Deprecated.
The WebSphere Commerce Payments secondary return code indicating the respnse
refers to an order entity.
|
static int |
SRC_USER_NOT_AUTHORIZED
Deprecated.
The WebSphere Commerce Payments secondary return code indicating that the user is
not authorized to perform the requested operation.
|
static java.lang.String |
TOTAL_SHIPPING_AMOUNT
Deprecated.
Environment variable name for the total shipping amount parameter.
|
static java.lang.String |
TOTAL_TAX_AMOUNT
Deprecated.
Environment variable name for the total tax amount parameter.
|
CC_VALID_Y_RANGE, 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, NVP_FIELD, PM_MESSAGE_FOR_BUYER, PM_MESSAGE_FOR_MERCHANT, PM_PRIMARY_RC, PM_SECONDARY_RC, WCSHOSTNAME, WCSWEBSERVERPORT, WEBPATH
Constructor and Description |
---|
DoPaymentMPFCmdImpl()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getContentType()
Deprecated.
Returns the Content Type (or MIME type) of the return data, or
null if
the type is not known. |
java.lang.String |
getOrderState()
Deprecated.
Returns the single character String value that this command
wants the Calling command to use to set the Status of the order.
|
byte[] |
getReturnData()
Deprecated.
Returns the byte Array containing Return Data from the payment system.
|
boolean |
isReadyToCallExecute()
Deprecated.
This method is called by the Command Framework to check if all basic mandatory
parameters have been set for this command.
|
void |
performExecute()
Deprecated.
Performs the main business logic of the command.
|
void |
reset()
Deprecated.
Resets the instance variables of the command.
|
void |
setOrderId(java.lang.Long orderId)
Deprecated.
Sets the orderId property of the command.
|
void |
setPaymentAttributes(TypedProperty paymentAttributes)
Deprecated.
Sets the paymentAttributes property of the command.
|
void |
setPaymentMethodId(java.lang.Integer nPayMthdId)
Deprecated.
DoPaymentMPFInternalCmd was removed, and policyId will be used for payment processing.
This method will be useless, only for backward compatibility
|
void |
setPolicyId(java.lang.Long n)
Deprecated.
Sets the policyId property of the command.
|
void |
setTotalAmount(java.math.BigDecimal totalAmount)
Deprecated.
Sets the totalAmount property of the command.
|
accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache
getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
public static final int PRC_VALUE_ERROR
public static final int PRC_DUPLICATE_OBJECT
public static final int SRC_INITIALIZATION_MESSAGE
public static final int SRC_ORDER
public static final int SRC_CONNECTION_TO_PM_FAILED
public static final int SRC_USER_NOT_AUTHORIZED
public static final int SRC_AMOUNT
public static final java.lang.String PAYMTHD_SET
public static final java.lang.String PAYMTHD_PSRVR
public static final java.lang.String BILLTO_FIRSTNAME
public static final java.lang.String BILLTO_MIDDLENAME
public static final java.lang.String BILLTO_LASTNAME
public static final java.lang.String BILLTO_ADDRESS1
public static final java.lang.String BILLTO_CITY
public static final java.lang.String BILLTO_STATE
public static final java.lang.String BILLTO_ZIPCODE
public static final java.lang.String BILLTO_COUNTRY
public static final java.lang.String BILLTO_COUNTRY_CODE
public static final java.lang.String BILLTO_ADDRESS2
public static final java.lang.String BILLTO_PHONE_NUMBER
public static final java.lang.String BILLTO_EMAIL_ADDR1
public static final java.lang.String LANGUAGE_ENCODING
public static final java.lang.String CURRENCY_FACTOR
public static final java.lang.String TOTAL_TAX_AMOUNT
public static final java.lang.String TOTAL_SHIPPING_AMOUNT
public static final java.lang.String CARD_NUMBER
public static final java.lang.String CARD_EXPIRY
public static final java.lang.String APPROVAL_AMOUNT
public static final java.lang.String CURRENCY_ALPHA_CODE
public static final java.lang.String BUYER_LANGUAGE_ID
public java.lang.String getContentType()
null
if
the type is not known.getContentType
in interface DoPaymentCmd
String
containing the name of the MIME type of the return data,
or null if the type is not knownpublic java.lang.String getOrderState()
getOrderState
in interface DoPaymentCmd
public byte[] getReturnData()
This method returns a zero length byte array if there is no return data from the payment system.
getReturnData
in interface DoPaymentCmd
public boolean isReadyToCallExecute()
isReadyToCallExecute
in interface com.ibm.websphere.command.Command
isReadyToCallExecute
in class AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface ECCommand
performExecute
in interface com.ibm.websphere.command.TargetableCommand
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 interface com.ibm.websphere.command.Command
reset
in class AbstractECTargetableCommand
public void setOrderId(java.lang.Long orderId)
setOrderId
in interface DoPaymentCmd
orderId
- the order reference number of the Order for which payment
is to be processed.public void setPaymentAttributes(TypedProperty paymentAttributes)
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 PONumber The purchase order number 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.
The PONumber attribute is required if the Account associated with the trading agreements used for the order includes a Purchase Order Terms and Conditions.
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 WebSphere Commerce Payments is used. The BrandID is case-sensitive.
Note: other payment attributes may be specified dependent on the payment method used to process the payment.
setPaymentAttributes
in interface DoPaymentCmd
paymentAttributes
- the TypedProperty object containing all
the parameters to be passed to this command.DoPaymentMPFCmdImpl
public void setPaymentMethodId(java.lang.Integer nPayMthdId)
nPayMthdId
- Integerpublic void setPolicyId(java.lang.Long n)
n
- The ID of the Payment Policy to be used to process payment
for this Order.public void setTotalAmount(java.math.BigDecimal totalAmount)
setTotalAmount
in interface DoPaymentCmd
totalAmount
- the total price of the Order for which payment
is to be processed.