OrderCancelCmd

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

AccCommand, 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:

OrderCancelCmdImpl
```
public interface OrderCancelCmd
extends ControllerCommand
```
This controller command is used to cancel the specified order. This controller command is intended to be used by a user to cancel one of its Orders. There is no default implementation of this command.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
The IBM copyright notice field.

static java.lang.String NAME
The full name of this command.
- Fields inherited from interface com.ibm.commerce.command.ECCommand
  defaultCommandClassName
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`setOrderId(java.lang.Long anOrderId)` This method sets the id of the order to cancel.
`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.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 full name of this command.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setOrderId
```
void setOrderId(java.lang.Long anOrderId)
```
    This method sets the id of the order to cancel.
    
    Parameters:
    
    anOrderId - A Long that specifies the Order identifier.
  - setUrl
```
void setUrl(java.lang.String astrUrl)
```
    This method sets the redirection URL to be called when the command completes successfully.
    
    Parameters:
    
    astrUrl - A String that specifies the redirection URL string.