com.ibm.commerce.payment.commands

Interface DoPaymentPolicyCmd

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        Deprecated. 
        IBM copyright notice field.
        See Also:
        Constant Field Values

      • NAME

        static final java.lang.String NAME
        Deprecated. 
        The name of this command.
        See Also:
        Constant Field Values

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        Deprecated. 
        The default implementation of this command.
        See Also:
        Constant Field Values

      • ERRTASK_NAME

        static final java.lang.String ERRTASK_NAME
        Deprecated. 
        Name of the default error view for this command. The constant value of this field is "DoPaymentErrorView".
        See Also:
        Constant Field Values

      • NVP_FIELD

        static final java.lang.String NVP_FIELD
        Deprecated. 
        Property name for the field property passed in the exceptionData of an ErrorDataBean. The property is included if the "ErrorCode" property indicates a parameter is missing (ERR_CODE_MISSING_PARAM).
        See Also:
        ErrorDataBean, Constant Field Values

      • NVP_field

        static final java.lang.String NVP_field
        Deprecated. Use NVP_FIELD instead.
        Property name for the field property passed in the exceptionData of an ErrorDataBean. The value of this constant is the same as NVP_FIELD.
        See Also:
        NVP_FIELD, Constant Field Values

      • PM_PRIMARY_RC

        static final java.lang.String PM_PRIMARY_RC
        Deprecated. 
        Property name for the PrimaryRC property passed in the exceptionData of an ErrorDataBean. If included in the exception data, the property holds the primary return code from WebSphere Commerce Payments.
        See Also:
        ErrorDataBean, Constant Field Values

      • PM_SECONDARY_RC

        static final java.lang.String PM_SECONDARY_RC
        Deprecated. 
        Property name for the SecondaryRC property passed in the exceptionData of an ErrorDataBean. If included in the exception data, the property holds the secondary return code from WebSphere Commerce Payments.
        See Also:
        ErrorDataBean, Constant Field Values

      • PM_MESSAGE_FOR_BUYER

        static final java.lang.String PM_MESSAGE_FOR_BUYER
        Deprecated. 
        Property name for the MessageForBuyer property passed in the exceptionData of an ErrorDataBean. If included in the exception data, the property holds the optional message that accompanies the primary and secondary error codes received from WebSphere Commerce Payments. This message is suitable for display to the buyer.
        See Also:
        ErrorDataBean, Constant Field Values

      • PM_MESSAGE_FOR_MERCHANT

        static final java.lang.String PM_MESSAGE_FOR_MERCHANT
        Deprecated. 
        Property name for the MessageForMerchant property passed in the exceptionData of an ErrorDataBean. If included in the exception data, the property holds the optional message that accompanies the primary and secondary error codes received from WebSphere Commerce Payments. This message is suitable for display to the merchant/mall system administrator.
        See Also:
        ErrorDataBean, Constant Field Values

      • MESSAGE_FOR_BUYER

        static final java.lang.String MESSAGE_FOR_BUYER
        Deprecated. 
        Property name for the MessageForBuyer property passed in the exceptionData of an ErrorDataBean. The value of this constant is the same as PM_MESSAGE_FOR_BUYER.
        See Also:
        PM_MESSAGE_FOR_BUYER, Constant Field Values

      • WCSHOSTNAME

        static final java.lang.String WCSHOSTNAME
        Deprecated. 
        Environment variable name for the WebSphere Commerce host. This is one of the environment variables that is passed to the Payment Cashier if payment is to be processed through WebSphere Commerce Payments.
        See Also:
        com.ibm.commerce.payment.commands.DoPaymentPMCmdImpl, Constant Field Values

      • WCSWEBSERVERPORT

        static final java.lang.String WCSWEBSERVERPORT
        Deprecated. 
        Environment variable name for the WebSphere Commerce web server port. This is one of the environment variables that is passed to the Payment Cashier if payment is to be processed through WebSphere Commerce Payments.
        See Also:
        com.ibm.commerce.payment.commands.DoPaymentPMCmdImpl, Constant Field Values

      • WEBPATH

        static final java.lang.String WEBPATH
        Deprecated. 
        Environment variable name for the WebSphere Commerce webpath. This is one of the environment variables that is passed to the Payment Cashier if payment is to be processed through WebSphere Commerce Payments.
        See Also:
        com.ibm.commerce.payment.commands.DoPaymentPMCmdImpl, Constant Field Values

      • CC_VALID_Y_RANGE

        static final int CC_VALID_Y_RANGE
        Deprecated. 
        The valid credit card expiry year range. The credit card expiry year cannot exceed this number of year from the current year.
        See Also:
        Constant Field Values

    • Method Detail

      • getContentType

        java.lang.String getContentType()
        Deprecated. 
        Returns the Content Type (or MIME type) of the return data, or null if the type is not known.
        Returns:
        a String containing the name of the MIME type of the return data, or null if the type is not known

      • getOrderState

        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 null, the Calling command will decide the value to use for the Status
        Returns:
        the preferred order state

      • getReturnData

        byte[] getReturnData()
        Deprecated. 
        Returns the byte Array containing Return Data from the Payment System. If the Payment System does not use Return Data then the byte Array will be null or of zero length.
        Returns:
        the byte Array containing Return Data from the Payment System

      • setAccount

        void setAccount(AccountAccessBean abAccount)
        Deprecated. 
        Sets the account property of the command.
        Parameters:
        abAccount - the AccountAccessBean representing the account the order is associated with

      • setBuyerPOId

        void setBuyerPOId(java.lang.Long nBuyerPOId)
        Deprecated. 
        Sets optional buyerPOId if the customer (buyer) had specified a buyer purchase order number.
        Parameters:
        nBuyerPOId - the internal ID of the BuyerPO record representing the purchase order number specified

      • setErrorViewName

        void setErrorViewName(java.lang.String sEVN)
        Deprecated. 
        Sets the error view to be used to report error. This overrides the default error view of the command.
        Parameters:
        sEVN - the Error View name
        See Also:
        ERRTASK_NAME

      • setOrder

        void setOrder(OrderAccessBean ab)
        Deprecated. 
        Sets the order property of the command.
        Parameters:
        ab - the OrderAccessBean representing the order for which payment is to be processed.

      • setPaymentAttributes

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

        Some of the optional Payment Attributes that may be passed to the command are: 

               Keyword                         Value
     ===========        ====================================
     cardBrand          The credit card brand.  
     cardNumber         The credit card number              
     cardExpiryMonth    The credit card exipration month  
     cardExpiryYear     The credit card exipration year
        See the command implementation class for the actual list of parameters that are expected.
        Parameters:
        requestProperties - the TypedProperty object that contains all the command parameters to be passed to this command.

      • setTotalAmount

        void setTotalAmount(java.math.BigDecimal totalAmount)
        Deprecated. 
        Sets the totalAmount property of the command.
        Parameters:
        totalAmount - the total price of the order for which payment is to be processed.
Skip navigation links