com.ibm.commerce.payment.ppc.commands

Class PPCPayInstExtendedEditCmdImpl

  • All Implemented Interfaces:
    com.ibm.commerce.base.helpers.EJBConstants, AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, PPCPayInstExtendedEditCmd, Protectable, ECConstants, ToolsControllerCommand, ECToolsConstants, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable


    public class PPCPayInstExtendedEditCmdImpl
    extends ToolsControllerCommandImpl
    implements PPCPayInstExtendedEditCmd, ECConstants, ECToolsConstants, com.ibm.commerce.base.helpers.EJBConstants
    This is the default implementation of the PPCPayInstExtendedEditCmd tools controller command.

    Input parameters:

    Name XPath Description
    piId /XML/piId The identifier of current payment instruction object. Mandatory.
    extDataSize /XML/extDataSize The size of the extended data of this payment instruction object.
    extData /XML/extData The extended data of this payment instruction object.

    Output parameters:

    None.

    Behaviour:

    • Validates the required parameters and if the format of these parameters is valid.
    • Calls the method updatePaymentInstructionExtendedData of com.ibm.commerce.payments.plugincontroller.beans.PluginControllerJDBCHelper to edit the payment information.
    • If the redirect URL is not specified, it calls GenericRedirectView upon successful completion, or GenericApplicationError upon failure.

    Task commands called:

    None.
    See Also:
    com.ibm.commerce.payments.plugincontroller.beans.PluginControllerJDBCHelper, PPCCreditEditCmdImpl, PPCPaymentEditCmdImpl, Serialized Form
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The internal copyright field.
        See Also:
        Constant Field Values
      • CLASS_NAME

        public static final java.lang.String CLASS_NAME
        The class name
        See Also:
        Constant Field Values
    • Constructor Detail

      • PPCPayInstExtendedEditCmdImpl

        public PPCPayInstExtendedEditCmdImpl()
    • Method Detail

      • validateParameters

        public void validateParameters()
                                throws ECException
        This method returns the payment instruction extended data information from requestProperties and sets the information into the command local variables. It also sets the success redirect URL.
        Specified by:
        validateParameters in interface ECCommand
        Overrides:
        validateParameters in class AbstractECTargetableCommand
        Throws:
        ECException - If the XMLObject cannot be parsed as expected, throw ECApplicationException.
      • performExecute

        public void performExecute()
                            throws ECException
        This method performs the updating of payment instruction extended data information, which invokes WebSphere Commerce Payments JDBCHelper to execute this action.
        Specified by:
        performExecute in interface ECCommand
        Specified by:
        performExecute in interface com.ibm.websphere.command.TargetableCommand
        Overrides:
        performExecute in class AbstractECTargetableCommand
        Throws:
        ECException - In case of any ECException
      • getPaymentContext

        public PaymentContext getPaymentContext()
                                         throws java.lang.Exception
        The method returns the PaymentContext that contains the order channel id, locale, payment configuration group id, and store id.
        Returns:
        paymentContext The current payment context
        Throws:
        java.lang.Exception - In case of any failure
      • getExtData

        public ExtendedData getExtData()
        This method returns the extended data of this payment instruction.
        Returns:
        extData The extended data of this payment instruction
      • setExtData

        public void setExtData(ExtendedData map)
        This method sets the extended data of this payment instruction.
        Parameters:
        map - The extended data to set
      • getPaymentInstructionId

        public java.lang.String getPaymentInstructionId()
        This method returns the current payment instruction Id.
        Returns:
        paymentInstructionId The current payment instruction Id
      • setPaymentInstructionId

        public void setPaymentInstructionId(java.lang.String string)
        This method sets the current payment instruction Id.
        Parameters:
        string - The payment instruction Id to set