public class PaymentProcessFinancialTransactionCmdImpl extends ControllerCommandImpl implements PaymentProcessFinancialTransactionCmd
Name | XPath | Description |
---|---|---|
channelId | ApplicationArea/BusinessContext/ContextData[@name='channelId'] | The order channel ID used currently. Mandatory. |
locale | ApplicationArea/BusinessContext/ContextData[@name='locale'] | The locale used currently. Such as: CA, EN, and US and so forth. Mandatory. |
paymentConfigurationGroupId | DataArea/FinancialTransaction/Payment/PaymentInstruction/PaymentConfigurationID or DataArea/FinancialTransaction/Credit/PaymentInstruction/PaymentConfigurationID | The current payment configuration group ID. Default it is "default". Optional. If it is not defined in the input parameters, there are two alternatives. 1) If the Payment/Credit ID or the Payment Instruction ID is defined in the input parameters, it will be retrieved from the corresponding Payment Instruction. 2) If the paymentMethodName is defined, it will be retrieved via the configuration in Payment Rules. |
storeId | DataArea/FinancialTransaction/Payment/PaymentInstruction/StoreID or DataArea/FinancialTransaction/Credit/PaymentInstruction/StoreID | The current store ID. Optional. If it is not defined in the input parameters, and the Payment/Credit ID or Payment Instruction ID is defined in the input parameters. Then it will be retrieved from the corresponding Payment Instruction. |
paymentMethodName | DataArea/FinancialTransaction/Payment/PaymentInstruction/PaymentMethodName or DataArea/FinancialTransaction/Credit/PaymentInstruction/PaymentMethodName | The payment method name used by current financial transaction. Optional. |
action | DataArea/FinancialTransaction@type | The financial type of current financial transaction. Possible values include "approve","deposit", credit,reverseApproval, reverseDeposit, and reverseCredit. Mandatory. |
amount | DataArea/FinancialTransaction/RequestedAmount | The requested amount needs to process of current financial transaction. Mandatory. |
currency | DataArea/FinancialTransaction/RequestedAmount@currency | The current used by current financial transaction. Mandatory. |
extendedDataName | DataArea/FinancialTransaction/Payment/PaymentInstruction/ExtendedData@name | The extended data name. Optional. |
extendedDataValue | DataArea/FinancialTransaction/Payment/PaymentInstruction/ExtendedData@value | The extended data value. Optional. |
orderId | DataArea/FinancialTransaction/Payment/PaymentInstruction/OrderIdentifier/OrderID | The order ID of current financial transaction. Optional. |
rmaId | DataArea/FinancialTransaction/Credit/PaymentInstruction/RMAIdentifier/RMAID | The RMA ID of current financial transaction. Optional. |
paymentSystemName | DataArea/FinancialTransaction/Payment/PaymentInstruction/PaymentSystemName or DataArea/FinancialTransaction/Credit/PaymentInstruction/PaymentSystemName | The current payment system name. Optional. If it is not defined in the input parameters, there are two alternatives. 1) If the Payment/Credit ID or the Payment Instruction ID is defined in the input parameters, it will be retrieved from the corresponding Payment Instruction. 2) If the paymentMethodName is defined, it will be retrieved via the configuration in Payment Rules. |
paymentId or creditId | DataArea/FinancialTransaction/Payment/PaymentIdentifier/PaymentID or DataArea/FinancialTransaction/Credit/PaymentIdentifier/CreditID | The Payment ID of current financial transaction. Optional. |
paymentInstructionId | DataArea/FinancialTransaction/Payment/PaymentInstruction/PaymentInstructionIdentifier/PaymentInstructionID | The Payment Instruction ID of current financial transaction. Optional. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String | CLASSNAME
The name of this command is "com.ibm.commerce.payment.ppc.commands.PaymentProcessFinancialTransactionCmdImpl".
|
static java.lang.String | COPYRIGHT
The internal copyright field.
|
Constructor and Description |
---|
PaymentProcessFinancialTransactionCmdImpl()
This is the class constructor.
|
Modifier and Type | Method and Description |
---|---|
protected java.lang.String | getAction(java.lang.Integer i)
This method returns the input parameter action with enumeration group i.
|
protected java.math.BigDecimal | getAmount(java.lang.Integer i)
This method returns the input parameter amount with enumeration group i.
|
java.lang.String | getChannelId(java.lang.Integer i)
This method returns input parameter channel id with enumeration group i.
|
protected java.lang.String | getCreditId(java.lang.Integer i)
This method returns the input parameter credit id with enumeration group i.
|
protected java.lang.String | getCurrency(java.lang.Integer i)
This method returns the input parameter currency with enumeration group i.
|
protected java.util.HashMap | getExtendedDataNVP(java.lang.Integer i)
This method returns the name value pair of extendedDataName and extendedDataValue with enumeration group i.
|
java.util.Locale | getLocale(java.lang.Integer i)
This method returns input parameter locale with enumeration group i.
|
protected com.ibm.commerce.payments.plugincontroller.beans.ObjectModuleFacadeLocal | getOMF()
This method returns the facade for WebSphere Commerce Payments DB, which is used to actually access the corresponding data in the DB.
|
java.lang.String | getOrderId(java.lang.Integer i)
This method returns input parameter order id with enumeration group i.
|
java.lang.String | getPaymentConfigurationGroupId(java.lang.Integer i)
This method returns input parameter payment configuration group id with enumeration group i.
|
protected java.lang.String | getPaymentConfigurationId(java.lang.Integer i)
This method returns the input parameter payment configuration id with enumeration group i.
|
protected java.lang.String | getPaymentId(java.lang.Integer i)
This method returns the input parameter payment id with enumeration group i.
|
protected java.lang.String | getPaymentInstructionId(java.lang.Integer i)
This method returns the input parameter payment instruction id with enumeration group i.
|
java.lang.String | getPaymentMethodName(java.lang.Integer i)
This method returns input parameter payment method name with enumeration group i.
|
protected com.ibm.commerce.payments.plugincontroller.beans.PluginController | getPaymentsFacade()
This method returns the facade for WebSphere Commerce Payments, which is used to actually calls the corresponding actions in WebSphere Commerce Payments.
|
protected java.lang.String | getPaymentSystemName(java.lang.Integer i)
This method returns the input parameter payment system name with enumeration group i.
|
AccessVector | getResources()
This method returns command resources for access control.
|
java.lang.String | getRMAId(java.lang.Integer i)
This method returns input parameter RMA id with enumeration group i.
|
java.lang.Integer | getStoreId(java.lang.Integer i)
This method returns input parameter store id with enumeration group i.
|
void | performExecute()
This method contains the actual business logic of the command as per the WebSphere Commerce command framework.It calls WebSphere Commerce Payments to process payment actions.
|
void | reset()
This method resets the command fields.
|
void | setRequestProperties(TypedProperty reqProperties)
This method sets the input parameters from the request properties.
|
void | validateParameters()
This method verifies that required input parameters are present and correct.
|
protected void | validateParameters(java.lang.Integer i)
This method verifies that required input parameters are present and correct for enumeration group i.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
public PaymentProcessFinancialTransactionCmdImpl()
protected java.lang.String getAction(java.lang.Integer i)
protected java.math.BigDecimal getAmount(java.lang.Integer i) throws ECException
protected java.lang.String getCurrency(java.lang.Integer i)
protected java.util.HashMap getExtendedDataNVP(java.lang.Integer i)
protected java.lang.String getCreditId(java.lang.Integer i)
protected java.lang.String getPaymentId(java.lang.Integer i)
protected java.lang.String getPaymentConfigurationId(java.lang.Integer i)
protected java.lang.String getPaymentInstructionId(java.lang.Integer i)
protected java.lang.String getPaymentSystemName(java.lang.Integer i)
public void setRequestProperties(TypedProperty reqProperties) throws ECException
public void performExecute() throws ECException
public void validateParameters() throws ECException
protected void validateParameters(java.lang.Integer i) throws ECException
public AccessVector getResources() throws ECException
public java.lang.String getChannelId(java.lang.Integer i)
public java.util.Locale getLocale(java.lang.Integer i)
public java.lang.String getOrderId(java.lang.Integer i)
public java.lang.String getRMAId(java.lang.Integer i)
public java.lang.String getPaymentConfigurationGroupId(java.lang.Integer i)
public java.lang.Integer getStoreId(java.lang.Integer i)
public java.lang.String getPaymentMethodName(java.lang.Integer i)
protected com.ibm.commerce.payments.plugincontroller.beans.PluginController getPaymentsFacade() throws J2EEException
protected com.ibm.commerce.payments.plugincontroller.beans.ObjectModuleFacadeLocal getOMF() throws InternalException
public void reset()
This method resets the command fields.
After this method is invoked, and proper attributes are set, the command can be executed again.