public class OrderCancelCmdImpl extends OrderBaseCmdImpl implements OrderCancelCmd
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. |
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String | istrCheckParametersFunc
function Name: checkParameters
|
protected static java.lang.String | istrIsReadyToCallExecuteFunc
function Name: isReadyToCallExecute
|
protected static java.lang.String | istrPerformFunc
function Name: performExecute
|
protected static java.lang.String | istrSetRequestPropertiesFunc
function Name: setRequestProperties
|
protected static java.lang.String | istrThisClass
The full name of this class.
|
Constructor and Description |
---|
OrderCancelCmdImpl()
This method is the default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void | cancelEDPOrder(java.lang.Long nOrderId, java.lang.Boolean forceCancel)
This method cancels EDP order for AOP.
|
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.
|
protected void | raiseBusinessEvent(OrderAccessBean orderAB)
This method raises the business event for the cancelled order.
|
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.
|
protected static java.lang.String istrThisClass
protected static java.lang.String istrIsReadyToCallExecuteFunc
protected static java.lang.String istrSetRequestPropertiesFunc
protected static java.lang.String istrPerformFunc
protected static java.lang.String istrCheckParametersFunc
public OrderCancelCmdImpl()
public java.lang.Long getOrderId()
public AccessVector getResources() throws ECException
public java.lang.String getUrl()
public void performExecute() throws ECException
public void reset()
public void setOrderId(java.lang.Long anOrderId)
public void setRequestProperties(TypedProperty aReqParms) throws ECApplicationException
public void setUrl(java.lang.String astrUrl)
public void validateParameters() throws ECException
public java.lang.Boolean getForcedCancel()
public void setForcedCancel(java.lang.Boolean forceCancel)
protected void cancelEDPOrder(java.lang.Long nOrderId, java.lang.Boolean forceCancel) throws ECException
protected void raiseBusinessEvent(OrderAccessBean orderAB) throws ECException