public class OrderCancelCmdImpl extends OrderBaseCmdImpl implements OrderCancelCmd
OrderCancelCmd
controller command.
Name | Description |
---|---|
langId |
Sets or resets the preferred language for the duration of the session; the supported languages for a store are found in the STORELANG table. |
forUser |
The logon ID of the user on whose behalf the command runs; only a person with the authority to process orders can specify this parameter. |
URL |
(Required) The URL that is called when the command completes successfully. |
storeId |
The store that is associated with the order. |
orderId |
(Required) The reference number of the order to cancel. |
forcedCancel |
(Optional) This parameter is used by payment rule to perform a refund. If there are some deposit transactions for the order, the order cannot be canceled except when the parameter is made forcedCancel=true. The default value is false. |
NAME
defaultCommandClassName
Constructor and Description |
---|
OrderCancelCmdImpl()
This method is the default constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getForcedCancel()
This method returns an indicator to force cancellation.
|
java.lang.Long |
getOrderId()
This method returns the identifier of the Order to cancel.
|
AccessVector |
getResources()
This method returns an
AccessVector containing the OrderAccessBean to be canceled. |
java.lang.String |
getUrl()
This method returns the redirection URL to be called when the command completes successfully.
|
void |
performExecute()
This method executes the business logic of this command implementation.
|
void |
reset()
Resets instance variables to their initial values.
|
void |
setForcedCancel(java.lang.Boolean forceCancel)
This method sets an indicator to force cancellation.
|
void |
setOrderId(java.lang.Long anOrderId)
This method sets the identifier of the Order to cancel.
|
void |
setRequestProperties(TypedProperty aReqParms)
The WebController calls the setRequestProperties method before invoking
the execute method in this command.
|
void |
setUrl(java.lang.String astrUrl)
This method sets the redirection URL to be called when the command completes successfully.
|
void |
validateParameters()
This method extracts and validates the input parameters of this command implementation.
|
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache
getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
fulfills, getOwner
public OrderCancelCmdImpl()
public java.lang.Long getOrderId()
public AccessVector getResources() throws ECException
AccessVector
containing the OrderAccessBean
to be canceled.
getResources
in interface ECCommand
getResources
in class AbstractECTargetableCommand
AccessVector
containing the OrderAccessBean
to be canceled..ECException
ECCommand#getResources()
public java.lang.String getUrl()
public void performExecute() throws ECException
status
attribute value of A, M, P, E, B, C, W, or X.
status
attribute value is set to X.status
attribute values of its OrderItems are set to X.viewTaskName
response property is set to the value "RedirectView"
.performExecute
in interface ECCommand
performExecute
in interface com.ibm.websphere.command.TargetableCommand
performExecute
in class AbstractECTargetableCommand
ECException
public void reset()
reset
in interface com.ibm.websphere.command.Command
reset
in class AbstractECTargetableCommand
public void setOrderId(java.lang.Long anOrderId)
setOrderId
in interface OrderCancelCmd
anOrderId
- A Long that specifies the Order identifier.public void setRequestProperties(TypedProperty aReqParms) throws ECApplicationException
setRequestProperties
in interface ControllerCommand
setRequestProperties
in class ControllerCommandImpl
aReqParms
- A TypedProperty that represents the details of request properties.ECException
ECApplicationException
ControllerCommand#setRequestProperties(TypedProperty)
public void setUrl(java.lang.String astrUrl)
setUrl
in interface OrderCancelCmd
astrUrl
- A String that specifies the redirection URL string.public void validateParameters() throws ECException
validateParameters
in interface ECCommand
validateParameters
in class AbstractECTargetableCommand
ECException
ECCommand#validateParameters()
public java.lang.Boolean getForcedCancel()
public void setForcedCancel(java.lang.Boolean forceCancel)
forceCancel
- A Boolean whose value is true if cancel is to be forced.