com.ibm.commerce.payment.commands

Class DoPaymentCmdImpl

  • All Implemented Interfaces:
    com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, DoPaymentCmd, 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
    Deprecated. 
    Replaced by PrimePaymentCmdImpl

    public class DoPaymentCmdImpl
extends TaskCommandImpl
implements DoPaymentCmd
    This DoPaymentCmd Task Command Implementation is called by the OrderProcessCmd Controller Command to process payment for an order.

    If the command is successful, the OrderProcessCmd will set the Order status to the value specified by this command.

    If unsuccessful, the command throws the ECApplicationException specifying an Error Code and the Error View named by the constant com.ibm.commerce.DoPaymentCmd.ERROR_TASK_NAME.

    This implementation of the DoPaymentCmd Task Command does not have any returnData for the OrderProcessCmd.

    Note: This is a sample only and must NOT be used for production. This sample does not use any of the new features (such as Contracts and Availability-To-Promise) introduced with WebSphere Commerce.

    This command uses the following AccessBeans:

    This command calls the following TaskCommands:

    See Also:
    Serialized Form

    • Constructor Detail

      • DoPaymentCmdImpl

        public DoPaymentCmdImpl()
        Deprecated. 

    • Method Detail

      • getContentType

        public java.lang.String getContentType()
        Deprecated. 
        Returns the Content Type (or MIME type) of the return data, or null if the type is not known.
        Specified by:
        getContentType in interface DoPaymentCmd
        Returns:
        a String containing the name of the MIME type of the return data, or null if the type is not known. Since this command implementation does not have return data, the method returns null.

      • getOrderState

        public java.lang.String getOrderState()
        Deprecated. 
        Returns the single character String value that the called command wants the Calling command to use to set the Status of the order. If the returned String is empty or null, the Calling command will decide the value to use for the Status
        Specified by:
        getOrderState in interface DoPaymentCmd
        Returns:
        the preferred order state

      • getReturnData

        public byte[] getReturnData()
        Deprecated. 
        Returns the byte Array containing Return Data from the Payment System. The Payment System used by this command does not use Return Data. Therefore return null.
        Specified by:
        getReturnData in interface DoPaymentCmd
        Returns:
        null

      • isCardExpiryDateValid

        public static boolean isCardExpiryDateValid(int expiryMonth,
                                            int expiryYear)
        Deprecated. 
        Checks if the specified expiry date (expiryMonth and expiryYear) is valid.
        Parameters:
        expiryMonth - the calender month of the expiry date (1 for January, 2 for February, and so on.)
        expiryYear - the calender year of the expiry date
        Returns:
        ture if the expiry date is valid.

      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        Deprecated. 
        This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. This is done before the Framework calls the performExecute method of the command.
        Specified by:
        isReadyToCallExecute in interface com.ibm.websphere.command.Command
        Overrides:
        isReadyToCallExecute in class AbstractECTargetableCommand
        Returns:
        true if we can execute the command; false otherwise.

      • removeSpaceAndHyphenFromString

        public static java.lang.String removeSpaceAndHyphenFromString(java.lang.String aCardNumber)
        Deprecated. 
        Returns a new string that is free of any spaces and hyphenated characters. If the supplied string is already free of spaces and hyphens the same string may be returned.
        Parameters:
        aCardNumber - the card number to be examined and stripped
        Returns:
        a string free of spaces and hyphenated characters ('-')

      • reset

        public void reset()
        Deprecated. 
        Resets the instance variables of the command. The reset() method will reset all instance variables. If the command includes any output values that are accessible via getters, then make sure those values are no longer needed before calling this method to reset the instance variables of the command.

        This is useful if the command instance is to be called multiple times with different command parameters.

        Specified by:
        reset in interface com.ibm.websphere.command.Command
        Overrides:
        reset in class AbstractECTargetableCommand

      • setOrderId

        public void setOrderId(java.lang.Long orderId)
        Deprecated. 
        Sets the orderId property of the command.
        Specified by:
        setOrderId in interface DoPaymentCmd
        Parameters:
        orderId - the order ID of the Order for which payment is to be processed.

      • setPaymentAttributes

        public void setPaymentAttributes(TypedProperty paymentAttributes)
        Deprecated. 
        Sets the paymentAttributes property of the command.

        This command requires the following Payment Attributes: 

               Keyword                         Value
     ===========        ====================================
     cardBrand          The credit card brand.  Represents the credit card type used.
     cardNumber         The credit card number
     cardExpiryMonth    The credit card exipration month
     cardExpiryYear     The credit card exipration year
        Note that this command stores the credit card brand in the PAYMETHOD column of the ORDPAYMTHD table and the size of the column is limited to five characters long.
        Specified by:
        setPaymentAttributes in interface DoPaymentCmd
        Parameters:
        paymentAttributes - the TypedProperty object that contains all the command parameters passed to this command.
        See Also:
        DoPaymentMPFCmdImpl

      • setTotalAmount

        public void setTotalAmount(java.math.BigDecimal totalAmount)
        Deprecated. 
        Sets the totalAmount property of the command.
        Specified by:
        setTotalAmount in interface DoPaymentCmd
        Parameters:
        totalAmount - the total price of the Order for which payment is to be processed.
Skip navigation links