public class PIAddCmdImpl extends AEDPPIEditCtrlCmdImpl implements PIAddCmd
This is the default implementation of the PIAddCmd controller command.
Name | Description |
---|---|
orderId | The identifier of the order to which the payment method is to be added. Mandatory. |
unbound | The flag that indicates if the payment instruction to be added is an unbound one or not. |
URL | The URL to be redirected when the command completes successfully. Mandatory. |
piAmount | The amount in the order currency to be used for this payment method. The format of this number must fit the rules for a java.math.BigDecimal object. The number must use a period for a decimal place. Mandatory |
policyId | The payment policy identifier. It is the primary key of the payment business policy table. (Table POLICY with column policytype_id = 'Payment'). If this parameter is missing, then payMethodId should be mandatory, and this command tries to get the policy identifier from business policy table via the policy name as payMethodId. |
payMethodId | The payment method name. It is the policy name of the payment business policy table. (Table POLICY with column policytype_id = 'Payment'). If policyId is passed in, this parameter is not required since this command always sets it as the policy name from business policy table via the policyId. |
protocolData | Additional name-value pairs that will be passed to the payment plug-in or payment processor as additional data required by that payment protocol. For example, for a credit card, cc_brand=AMEX. |
purchaseorder_id | The purchase order number specified to the order. This parameter is optional. If it is set, the value of the purchase order number will send back to the response properties to be displayed in the page. |
errorViewName | The view name which is redirected to when the execution fails. If this parameter is provided, the default error view name is PaymentInstructionErrorView. |
billing_address_id | The billing address identifier in WebSphere Commerce instance. |
paymentTCId | The payment Term & Condition identifier for this payment instruction. This parameter is used by the business customer. |
valueFromPaymentTC | The flag to indicate: Whether the payment protocol data should be extracted from the payment Term&Condition identified by paymentTCId parameter. And whether ignore any protocol data passed in the request properties. The value includes "true" and "false", the default value is "false". |
valueFromProfileOrder | The flag to indicate: whether the payment protocol data should be extracted from the user's quick checkout profile. And whether ignore any protocol data passed in the request properties. The value includes "Y" and "N", the default value is "N". |
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
The IBM Copyright notice field.
|
Constructor and Description |
---|
PIAddCmdImpl()
The default constructor.
|
Modifier and Type | Method and Description |
---|---|
void | fetchAddedPaymentInstructionId(EDPEditResults edpEditResults)
This method fetchs the Id of the newly added payment instruction according to the returned edpEditResults
|
java.lang.Long | getAddedPaymentInstructionId()
This method returns the Id of the added payment instruction
|
void | performExecute()
This method executes the actual business logic of the command, which adds a new payment instruction in payment rules subcomponent.
|
void | reset()
This method resets the command fields.
|
void | setAddedPaymentInstructionId(java.lang.Long paymentInstructionId)
This method sets the payment instruction Id
|
void | setRequestProperties(TypedProperty reqProperties)
This method sets the request input parameters.
|
void | validateParameters()
This method verifies the input parameters.
|
public static final java.lang.String COPYRIGHT
public void setRequestProperties(TypedProperty reqProperties) throws ECException
public void setAddedPaymentInstructionId(java.lang.Long paymentInstructionId)
public java.lang.Long getAddedPaymentInstructionId()
public void fetchAddedPaymentInstructionId(EDPEditResults edpEditResults)
public void performExecute() throws ECException
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.
public void validateParameters() throws ECException