com.ibm.commerce.order.commands
Interface OrderCancelCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable
All Known Implementing Classes:
OrderCancelCmdImpl

public interface OrderCancelCmd
extends ControllerCommand

Cancels the specified order by changing its order status to X. This command does not remove the order from the database. An order can be cancelled any time before the OrderProcess command begins running.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String NAME
           
 
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
 
Method Summary
 void setOrderId(java.lang.Long anOrderId)
          Sets the id of the order to cancel.
 void setUrl(java.lang.String astrUrl)
          Sets the redirection url to be called when the command completes successfully.
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
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, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

NAME

public static final java.lang.String NAME
Method Detail

setOrderId

public void setOrderId(java.lang.Long anOrderId)
Sets the id of the order to cancel.
Parameters:
OrderId - java.util.Integer - order identifier

setUrl

public void setUrl(java.lang.String astrUrl)
Sets the redirection url to be called when the command completes successfully.
Parameters:
astrUrl - java.lang.String - redirection url string