com.ibm.commerce.payment.commands

Interface DoPaymentCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

DoPaymentCmdImpl, DoPaymentMPFCmdImpl

Deprecated.

Replaced by PrimePaymentCmd

public interface DoPaymentCmd
extends TaskCommand

The DoPaymentCmd Task Command is called by the OrderProcessCmd Controller Command to process payment for an order. 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

Fields

Modifier and Type	Field and Description
static int	CC_VALID_Y_RANGE Deprecated. The valid credit card expiry year range.
static java.lang.String	COPYRIGHT Deprecated. IBM copyright notice field.
static java.lang.String	defaultCommandClassName Deprecated. The default implementation of this command.
static java.lang.String	ERR_CODE_BAD_CCNUM Deprecated. Error code indicating invalid card number.
static java.lang.String	ERR_CODE_BAD_SYS Deprecated. Error code indicating a system error has occurred.
static java.lang.String	ERR_CODE_BAD_XDATE Deprecated. Error code indicating invalid expiry date.
static java.lang.String	ERR_CODE_MISSING_PARAM Deprecated. Error code indicating a missing parameter.
static java.lang.String	ERRTASK_NAME Deprecated. Name of the Error View for this command.
static java.lang.String	MESSAGE_FOR_BUYER Deprecated. Property name for the MessageForBuyer property passed in the exceptionData of an ErrorDataBean.
static java.lang.String	NAME Deprecated. The name of this command.
static java.lang.String	NVP_field Deprecated. Use NVP_FIELD instead.
static java.lang.String	NVP_FIELD Deprecated. Property name for the field property passed in the exceptionData of an ErrorDataBean.
static java.lang.String	PM_MESSAGE_FOR_BUYER Deprecated. Property name for the MessageForBuyer property passed in the exceptionData of an ErrorDataBean.
static java.lang.String	PM_MESSAGE_FOR_MERCHANT Deprecated. Property name for the MessageForMerchant property passed in the exceptionData of an ErrorDataBean.
static java.lang.String	PM_PRIMARY_RC Deprecated. Property name for the PrimaryRC property passed in the exceptionData of an ErrorDataBean.
static java.lang.String	PM_SECONDARY_RC Deprecated. Property name for the SecondaryRC property passed in the exceptionData of an ErrorDataBean.
static java.lang.String	WCSHOSTNAME Deprecated. Environment variable name for the WebSphere Commerce host.
static java.lang.String	WCSWEBSERVERPORT Deprecated. Environment variable name for the WebSphere Commerce web server port.
static java.lang.String	WEBPATH Deprecated. Environment variable name for the WebSphere Commerce webpath.

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContentType() Deprecated. Returns the Content Type (or MIME type) of the return data, or null if the type is not known.
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.
byte[]	getReturnData() Deprecated. Returns the byte Array containing Return Data from the Payment System.
void	setOrderId(java.lang.Long orderId) Deprecated. Sets the orderId property of the command.
void	setPaymentAttributes(TypedProperty requestProperties) Deprecated. Sets the paymentAttributes property of the command.
void	setTotalAmount(java.math.BigDecimal totalAmount) Deprecated. Sets the totalAmount property of the command.

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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

ERRTASK_NAME

static final java.lang.String ERRTASK_NAME

Deprecated.

Name of the Error View for this command. The constant value of this field is "DoPaymentErrorView".

See Also:

Constant Field Values

ERR_CODE_MISSING_PARAM

static final java.lang.String ERR_CODE_MISSING_PARAM

Deprecated.

Error code indicating a missing parameter. The constant value of this field is "190".

See Also:

NVP_FIELD, Constant Field Values

ERR_CODE_BAD_CCNUM

static final java.lang.String ERR_CODE_BAD_CCNUM

Deprecated.

Error code indicating invalid card number. The constant value of this field is "1005".

See Also:

Constant Field Values

ERR_CODE_BAD_XDATE

static final java.lang.String ERR_CODE_BAD_XDATE

Deprecated.

Error code indicating invalid expiry date. The constant value of this field is "1006".

See Also:

Constant Field Values

ERR_CODE_BAD_SYS

static final java.lang.String ERR_CODE_BAD_SYS

Deprecated.

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:

ErrorDataBean, 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

defaultCommandClassName

static final java.lang.String defaultCommandClassName

Deprecated.

The default implementation of this command.

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:

byte[]

setOrderId

void setOrderId(java.lang.Long orderId)

Deprecated.

Sets the orderId property of the command.

Parameters:

orderId - the order reference number of the Order for which payment is to be processed.

setPaymentAttributes

void setPaymentAttributes(TypedProperty requestProperties)

Deprecated.

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
     ===========        ====================================
     cardBrand          The credit card brand.  
     cardNumber         The credit card number              
     cardExpiryMonth    The credit card exipration month  
     cardExpiryYear     The credit card exipration year
     cardVerifyCode     The credit card verification code.For example, Amex CID, Visa CVV, or MasterCard CVC number(Min/Max: 3-4 digits)
  
 

Refer to the documentation for the command implementation class for the actual Payment Attributes that are defined for the command.

See Also:

DoPaymentMPFCmdImpl

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.