java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.payment.commands.PayResetPMCmdImpl
This PayResetPMCmd
Controller Command implementation resets the
payment for an order that has been submitted to WebSphere Commerce Payments for
processing.
Only order that has failed the submission could have its payment reset via this command. If successful, this command also returns the WebSphere Commerce Order to the "Pending" state so that the Order could be re-submitted for processing.
This command uses the following AccessBeans:
This command does not call other TaskCommand.
Field Summary |
---|
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl |
requestProperties,
responseProperties,
retriable,
viewReqProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.payment.commands. PayResetPMCmd |
COPYRIGHT,
defaultCommandClassName,
ERR_CODE_BAD_SYS,
ERR_CODE_CANCEL_ORDER_NOT_ALLOWED,
ERRTASK_NAME,
NAME |
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand |
COPYRIGHT |
Constructor Summary | |
---|---|
PayResetPMCmdImpl() |
Method Summary | |
---|---|
protected
OrderAccessBean |
getOrderAccessBean() Returns the OrderAccessBean representing the order for which the payment information is to be reset. |
protected
java.lang.Long |
getOrderId() Gets the orderId property of the command. |
AccessVector |
getResources() Returns the resources accessed by this command. |
java.lang.Integer |
getStoreId() Gets the ID of the Store to which the order belongs. |
protected
java.lang.String |
getUrl() Gets the URL property of the command. |
boolean |
isReadyToCallExecute() This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. |
void |
performExecute() Performs the main business logic of the command. |
void |
reset() Resets the instance variables of the command. |
void |
setOrderId(java.lang.Long orderId) Sets the orderId property of the command. |
protected
void |
setStoreId(java.lang.Integer storeId) Saves the ID of the Store to which the order belongs. |
void |
setUrl(java.lang.String astrUrl) Sets the URL property of the command. |
void |
validateParameters() Checks the validity of supplied parameters. |
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
getViewInputProperties,
isGeneric,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setRequestProperties,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getUser,
getUserId,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. ECCommand |
checkIsAllowed,
checkResourcePermission,
createCommandExecutionEvent,
execute,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getUser,
getUserId,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
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.commerce.command. AccCommand |
accessControlCheck,
getAccCheck,
getForUserId,
getResourceOwners,
setAccCheck,
setForUserId,
setOwner |
Constructor Detail |
---|
public PayResetPMCmdImpl()
Method Detail |
---|
protected OrderAccessBean getOrderAccessBean()
protected java.lang.Long getOrderId()
public AccessVector getResources() throws ECException
For this command, the resource accessed is the order.
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
public java.lang.Integer getStoreId()
getStoreId
in interface
ECCommand
getStoreId
in class
AbstractECTargetableCommand
protected java.lang.String getUrl()
public boolean isReadyToCallExecute()
isReadyToCallExecute
in class
AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException.
ECException
public void reset()
This is useful if the command instance is to be called multiple times with different command parameters.
reset
in class
AbstractECTargetableCommand
public void setOrderId(java.lang.Long orderId)
setOrderId
in interface
PayResetPMCmd
orderId
- the ID of the Order for which the payment
information is to be reset.protected void setStoreId(java.lang.Integer storeId)
storeId
- the Store IDpublic void setUrl(java.lang.String astrUrl)
setUrl
in interface
PayResetPMCmd
astrUrl
- the URL to redirect to after the command completes
its processing.public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException.
ECException