com.ibm.commerce.edp.commands

Interface PIAddCmd

All Superinterfaces:

AccCommand, AEDPCtrlCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

PIAddCmdImpl, PIAddVoidCmdImpl

public interface PIAddCmd
extends AEDPCtrlCmd

This controller command is used to create a new payment method to an order. The default implementation of this command is PIAddCmdImpl.The PIAdd URL is mapped to this command by default.

See Also:

PICopyCmd, PIEditCmd, PIRemoveCmd

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM Copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation class name: "com.ibm.commerce.edp.commands.PIAddCmdImpl".
static java.lang.String	NAME the interface name.
static java.lang.String	PAYMENT_INSTRUCTION_ERROR_VIEW The default payment instruction error view.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getAddedPaymentInstructionId() This method returns the id of the added payment instruction
void	setAmount(java.math.BigDecimal amount) This method sets the payment instruction amount.
void	setPaymentMethodID(java.lang.String paymentMethod) This method sets the payment method of the new payment instruction.
void	setProtocolData(java.util.HashMap protocolData) This method sets the protocol data of the payment instruction.
void	setURL(java.lang.String url) This method sets the redirection URL to be called when the command completes successfully.

Methods inherited from interface com.ibm.commerce.edp.commands.AEDPCtrlCmd

getLocale, getOrderId, setOrderId

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

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties

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.CommandCaller

unionDependencies

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

accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

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

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

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

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

The IBM Copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

the interface name.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class name: "com.ibm.commerce.edp.commands.PIAddCmdImpl".

See Also:

Constant Field Values

PAYMENT_INSTRUCTION_ERROR_VIEW

static final java.lang.String PAYMENT_INSTRUCTION_ERROR_VIEW

The default payment instruction error view.

See Also:

Constant Field Values

Method Detail

setAmount

void setAmount(java.math.BigDecimal amount)

This method sets the payment instruction amount.

Parameters:

amount - the payment instruction amount

setPaymentMethodID

void setPaymentMethodID(java.lang.String paymentMethod)

This method sets the payment method of the new payment instruction.

Parameters:

paymentMethod - the payment method of the new payment instruction

setProtocolData

void setProtocolData(java.util.HashMap protocolData)

This method sets the protocol data of the payment instruction.

Parameters:

protocolData - the protocol data of the payment instruction

setURL

void setURL(java.lang.String url)

This method sets the redirection URL to be called when the command completes successfully.

Parameters:

url - the redirection URL

getAddedPaymentInstructionId

java.lang.Long getAddedPaymentInstructionId()

This method returns the id of the added payment instruction

Returns:

a long that specify the id of the new payment instruction