com.ibm.commerce.edp.commands

Interface PIEditCmd

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:

PIEditCmdImpl, PIEditVoidCmdImpl, PIEditWithMergingProtocolDataCmdImpl

public interface PIEditCmd
extends AEDPCtrlCmd

This controller command is used to change the details of an existing payment instruction in an order. The default implementation of this command is PIEditCmdImpl.The PIEdit URL is mapped to this command by default.

See Also:

PIAddCmd, PICopyCmd, 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 is "com.ibm.commerce.edp.commands.PIEditCmdImpl".
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
void	setAmountEditable(boolean amountEditable) This method sets the amount editable flag indicating if the amount is dirty or not.
void	setForcedPaymentInstructionChangeFlag(boolean forcedChange) This method sets the forced flag indicating if the payment instruction edit operation will be forced or not.
void	setPaymentDataEditable(boolean paymentDataEditable) This method sets the payment data editable flag indicating if the payment data is dirty or not.
void	setPIId(java.lang.Long aPIId) This method sets the payment instruction ID.
void	setProtocolData(java.util.HashMap protocalData) This method sets the protocol data of the payment instruction.
void	setURL(java.lang.String astrUrl) 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 is "com.ibm.commerce.edp.commands.PIEditCmdImpl".

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

setForcedPaymentInstructionChangeFlag

void setForcedPaymentInstructionChangeFlag(boolean forcedChange)

This method sets the forced flag indicating if the payment instruction edit operation will be forced or not.

It is up to the caller to set the forceFlag whether they want to do a forced payment instruction edit operation or not.

Parameters:

forcedChange - indicates if the request is forced or not

setPIId

void setPIId(java.lang.Long aPIId)

This method sets the payment instruction ID.

Parameters:

aPIId - the payment instruction ID

setProtocolData

void setProtocolData(java.util.HashMap protocalData)

This method sets the protocol data of the payment instruction.

Parameters:

protocalData - the protocol data of the payment instruction

setURL

void setURL(java.lang.String astrUrl)

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

Parameters:

astrUrl - the redirection URL

setPaymentDataEditable

void setPaymentDataEditable(boolean paymentDataEditable)

This method sets the payment data editable flag indicating if the payment data is dirty or not. True by default.

Parameters:

paymentDataEditable - indicates if the payment data is dirty or not

setAmountEditable

void setAmountEditable(boolean amountEditable)

This method sets the amount editable flag indicating if the amount is dirty or not. True by default.

Parameters:

amountEditable - indicates if the amount is dirty or not