public abstract class AEDPPIEditCtrlCmdImpl extends AEDPCtrlCmdImpl
This command implementation class is an abstract class that is inherited by payment instruction edit controller command implementation class, which includes PIAddCmdImpl,PIAddVoidCmdImpl,PICopyCmdImpl, PICopyVoidCmdImpl,PIEditCmdImpl,PIEditVoidCmdImpl, PIRemoveCmdImpland PIRemoveVoidCmdImpl.
It Contains common methods to all payment instruction edit controller commands above.
Modifier and Type | Field and Description |
---|---|
static java.lang.String | BILLING_ADDRESS_ID_PROPERTY_NAME
The keyword identifier for the billing address in the address book.
|
static java.lang.String | COPYRIGHT
The IBM copyright notice field.
|
static java.lang.String | EDP_EDIT_FORCEFLAG
Request parameter to indicate if the edit is 'forced' or not.
|
static java.lang.String | POLICY_ID
the policy id for payment instruction
|
static java.lang.String | PURCHASEORDER_ID_PROPERTY_NAME
The protocol data keyword identifier for a purchase order ID.
|
Constructor and Description |
---|
AEDPPIEditCtrlCmdImpl() |
Modifier and Type | Method and Description |
---|---|
java.math.BigDecimal | getAmount()
This method returns the amount of current payment instruction.
|
protected java.lang.String | getErrorViewName()
This method returns the error view name.
|
protected OrderAccessBean | getOrderAccessBean()
This method returns a reference to current order access bean.
|
protected java.lang.String | getPaymentMethodByPolicyId(java.lang.Long policyID)
This method returns the payment method name by the payment policy id.
|
java.lang.String | getPaymentMethodID()
This method returns the payment method of current payment instruction.
|
protected java.lang.Long | getPaymentTCId()
This method returns payment Term&Condition Id from request properties passed in.
|
java.lang.String | getPiIdNull()
This method returns the internal representation for a null payment instruction identifier.
|
java.lang.Long | getPolicyId()
This method returns the payment policy identifier of current payment instruction.
|
protected java.lang.Long | getPolicyIdByPaymentMethod(java.lang.String localPaymentMethod)
This method returns the payment policy ID by the payment method name.
|
java.util.HashMap | getProtocolData()
This method returns the protocol data of current payment instruction.
|
AccessVector | getResources()
This method returns the vector of resources accessed by this command, which uses the order access bean for resource access control.
|
protected java.math.BigDecimal | getTotalAmount()
This method returns the total amount of current order.
|
java.lang.String | getURL()
This method gets the redirection URL to be used when the command completes successfully
|
protected boolean | isBillingAddressPresent(TypedProperty requestProperties)
This method helps to determine if billing address has been passed in as request properties.
|
protected boolean | isDisplayAllowed(BusinessPolicyAccessBean abPolicy)
Check if the payment policy is allowed to display at the client.
|
protected void | processEDPEditResults(EDPEditResults edpEditResults)
This method processes the result object of the payment instruction edit operation.
|
void | reset()
This method resets the command fields.
|
void | setAmount(java.math.BigDecimal piAmount)
This method sets the amount of current payment instruction.
|
protected void | setBillingAddress(java.lang.String billingAddressId, java.util.HashMap edpPIExtendedData)
This method maps an address from the address book to predefined payment plug-in specification attributes.
|
protected void | setErrorViewName(java.lang.String errorViewName)
This method sets the error view name.
|
protected void | setOrderAccessBean(OrderAccessBean abOrder)
This method sets current order access bean.
|
void | setPaymentMethodID(java.lang.String localPaymentMethod)
This method sets the payment method of current payment instruction.
|
void | setPolicyId(java.lang.Long long1)
This method sets the payment policy identifier of current payment instruction.
|
void | setProtocolData(java.util.HashMap localProtocalData)
This method sets the protocol data of current payment instruction.
|
void | setURL(java.lang.String localRedirectionURL)
This method sets the redirection URL to be used when the command completes successfully.
|
protected void | validateBillingAddressId()
This method validates if billing address ID / payment TC ID passed in is valid
|
protected void | validateOrderPaymentMethod()
This method checks whether the payment method to be added comply with the BOPIS (Buy Online Pick In Store) rules.
|
protected void | validateOrderStatus()
This method checks whether the status of current order is valid when order is modified.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String BILLING_ADDRESS_ID_PROPERTY_NAME
public static final java.lang.String EDP_EDIT_FORCEFLAG
public static final java.lang.String PURCHASEORDER_ID_PROPERTY_NAME
public static final java.lang.String POLICY_ID
public void setAmount(java.math.BigDecimal piAmount)
public java.math.BigDecimal getAmount()
public void setPaymentMethodID(java.lang.String localPaymentMethod)
public java.lang.String getPaymentMethodID()
public java.lang.String getPiIdNull()
public void setProtocolData(java.util.HashMap localProtocalData)
public java.util.HashMap getProtocolData()
public java.lang.Long getPolicyId()
public void setPolicyId(java.lang.Long long1)
public AccessVector getResources() throws ECException
This method returns the vector of resources accessed by this command, which uses the order access bean for resource access control.
public void setURL(java.lang.String localRedirectionURL)
public java.lang.String getURL()
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.
protected void setBillingAddress(java.lang.String billingAddressId, java.util.HashMap edpPIExtendedData) throws ECApplicationException
This method maps an address from the address book to predefined payment plug-in specification attributes.
For example, getFirstName() is used to map into to billto_firstname
protected boolean isBillingAddressPresent(TypedProperty requestProperties)
protected void setErrorViewName(java.lang.String errorViewName)
protected java.lang.String getErrorViewName()
protected void setOrderAccessBean(OrderAccessBean abOrder)
protected OrderAccessBean getOrderAccessBean() throws ECException
This method returns a reference to current order access bean.
This method first checks if there is a local reference to the order access bean. If not present, it will create a new one.
protected java.lang.Long getPaymentTCId()
protected java.math.BigDecimal getTotalAmount() throws ECException
protected void processEDPEditResults(EDPEditResults edpEditResults) throws ECException
protected void validateBillingAddressId() throws ECException
protected void validateOrderStatus() throws ECException
protected void validateOrderPaymentMethod() throws ECException
protected java.lang.String getPaymentMethodByPolicyId(java.lang.Long policyID)
protected java.lang.Long getPolicyIdByPaymentMethod(java.lang.String localPaymentMethod)
protected boolean isDisplayAllowed(BusinessPolicyAccessBean abPolicy) throws java.rmi.RemoteException, javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException