com.ibm.commerce.payment.actions.commands

Interface UndoPaymentActionsCmd

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:

UndoPaymentActionsCmdImpl

public interface UndoPaymentActionsCmd
extends TaskCommand

This command executes the compensated payment action for the payment action that has been successfully executed. It is usually called when the overall WebSphere Commerce transaction rolls back while some payment actions have been successfully executed in this transaction. The default implementation class of this command is UndoPaymentActionsCmdImpl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation class.
static java.lang.String	NAME The name of the Command Interface class.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTicklerComments() This method returns the comments of the tickler.
boolean	isTicklerNeeded() This method returns whether a tickler is necessary when the undo payment action is not successfully executed.
void	setOriginalActionData(ActionData actionData) This method sets the original action data that has been successfully executed.

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

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of the Command Interface class.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class.

See Also:

Constant Field Values

Method Detail

setOriginalActionData

void setOriginalActionData(ActionData actionData)

This method sets the original action data that has been successfully executed.

Parameters:

actionData - the original action data that has been successfully executed

isTicklerNeeded

boolean isTicklerNeeded()

This method returns whether a tickler is necessary when the undo payment action is not successfully executed.

Returns:

whether a tickler is necessary when the undo payment action is not successfully executed

getTicklerComments

java.lang.String getTicklerComments()

This method returns the comments of the tickler.

Returns:

the comments of the tickler