com.ibm.commerce.payment.commands
Interface DoPaymentMPFInternalCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
DoPaymentMPFInternalCmdImpl

public interface DoPaymentMPFInternalCmd
extends TaskCommand

The DoPaymentMPFInternalCmd Task Command is called by the DoPaymentMPFCmdImpl Controller Command to process payment for an order when the payMethodId url parameter was specified with the OrderProcess command. If successful, the OrderProcessCmd will set the Order status to the value specified by this command and will return the returnData to the shopper to complete the payment initiation request. (The returnData may be null. In this case, the OrderProcessCmd will go to the OrderOK View to display a confirmation page to the shopper.) If unsuccessful, the command is expected to throw the ECApplicationException specifying the Error View Command named by the com.ibm.commerce.DoPaymentCmd.ERROR_TASK_NAME.


Field Summary
static int CC_VALID_Y_RANGE
           
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String ERR_CODE_BAD_CCNUM
          Error code indicating invalid card number.
static java.lang.String ERR_CODE_BAD_SYS
          Error code indicating a system error has occurred.
static java.lang.String ERR_CODE_BAD_XDATE
          Error code indicating invalid expiry date.
static java.lang.String ERR_CODE_MISSING_PARAM
          Error code indicating a missing parameter.
static java.lang.String ERRTASK_NAME
          Name of the Error View for this command.
static java.lang.String MESSAGE_FOR_BUYER
           
static java.lang.String NAME
           
static java.lang.String NVP_FIELD
          Constant for the name of a property passed in the exceptionData of an ErrorDataBean.
static java.lang.String PM_MESSAGE_FOR_BUYER
           
static java.lang.String PM_MESSAGE_FOR_MERCHANT
           
static java.lang.String PM_PRIMARY_RC
           
static java.lang.String PM_SECONDARY_RC
           
static java.lang.String WCSHOSTNAME
           
static java.lang.String WCSWEBSERVERPORT
           
static java.lang.String WEBPATH
           
 
Method Summary
 java.lang.String getContentType()
          Returns the Content Type (or MIME type) of the return data, or null if the type is not known.
 java.lang.String getOrderState()
          Returns the single character String value that the called command wants the Calling command to use to set the Status of the order.
 byte[] getReturnData()
          Returns the byte Array containing Return Data from the Payment System.
 void setOrderId(java.lang.Long orderId)
          Sets the orderId property of the command.
 void setPaymentAttributes(TypedProperty requestProperties)
          Sets the paymentAttributes property of the command.
 void setTotalAmount(java.math.BigDecimal totalAmount)
          Sets the totalAmount property of the command.
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

CC_VALID_Y_RANGE

public static final int CC_VALID_Y_RANGE

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.

ERR_CODE_BAD_CCNUM

public static final java.lang.String ERR_CODE_BAD_CCNUM
Error code indicating invalid card number. The constant value of this field is "1005".

ERR_CODE_BAD_SYS

public static final java.lang.String ERR_CODE_BAD_SYS
Error code indicating a system error has occurred. The constant value of this field is "1007".

If a Payment System is used to process the payment for the order, this error code could also be used to indicate an error detected by the Payment System. The implementation class of the command may return additional error property in the exceptionData of an ErrorDataBean passed to the Error View specified by the command.

See Also:
com.ibm.commerce.beans.ErrorDataBean.

ERR_CODE_BAD_XDATE

public static final java.lang.String ERR_CODE_BAD_XDATE
Error code indicating invalid expiry date. The constant value of this field is "1006".

ERR_CODE_MISSING_PARAM

public static final java.lang.String ERR_CODE_MISSING_PARAM
Error code indicating a missing parameter. The constant value of this field is "190".
See Also:
NVP_FIELD.

ERRTASK_NAME

public static final java.lang.String ERRTASK_NAME
Name of the Error View for this command. The constant value of this field is "DoPaymentErrorView".

MESSAGE_FOR_BUYER

public static final java.lang.String MESSAGE_FOR_BUYER

NAME

public static final java.lang.String NAME

NVP_FIELD

public static final java.lang.String NVP_FIELD
Constant for the name of a property passed in the exceptionData of an ErrorDataBean. The property is named "field". The "field" property is included if the "ErrorCode" property indicates a parameter is missing (ERR_CODE_MISSING_PARAM).
See Also:
com.ibm.commerce.beans.ErrorDataBean.

PM_MESSAGE_FOR_BUYER

public static final java.lang.String PM_MESSAGE_FOR_BUYER

PM_MESSAGE_FOR_MERCHANT

public static final java.lang.String PM_MESSAGE_FOR_MERCHANT

PM_PRIMARY_RC

public static final java.lang.String PM_PRIMARY_RC

PM_SECONDARY_RC

public static final java.lang.String PM_SECONDARY_RC

WCSHOSTNAME

public static final java.lang.String WCSHOSTNAME

WCSWEBSERVERPORT

public static final java.lang.String WCSWEBSERVERPORT

WEBPATH

public static final java.lang.String WEBPATH
Method Detail

getContentType

public java.lang.String getContentType()
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

public java.lang.String getOrderState()
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 single character order status for the Order object or null.

getReturnData

public byte[] getReturnData()
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:
byte[]

setOrderId

public void setOrderId(java.lang.Long orderId)
Sets the orderId property of the command.
Parameters:
orderId - the order reference number of the Order for which payment is to be processed.

setPaymentAttributes

public void setPaymentAttributes(TypedProperty requestProperties)
Sets the paymentAttributes property of the command.
Parameters:
requestProperties - the requestProperties object that contains all the command parameters are to be passed to this command.

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

       Keyword                         Value
     ===========        ====================================
     payMethodId        PayMthd_Id of the Cashier Profile to use
     cardBrand          The credit card brand.  
     cardNumber         The credit card number              
     cardExpiryMonth    The credit card exipration month  
     cardExpiryYear     The credit card exipration year   
     $XXXXXX            Protocol Data Value for $XXXXXX
 
where $XXXXXX are special Protocol Data Keyword defined by the Payment Manager Cassette. (The Protocol Data keywords all start with the "$" character.)

setTotalAmount

public void setTotalAmount(java.math.BigDecimal totalAmount)
Sets the totalAmount property of the command.
Parameters:
totalAmount - the total price of the Order for which payment is to be processed.