com.ibm.commerce.order.commands
Class ScheduledOrderCancelCmdImpl

com.ibm.commerce.command.AbstractECTargetableCommand
  |
  +--com.ibm.commerce.command.ControllerCommandImpl
        |
        +--com.ibm.commerce.order.commands.ScheduledOrderCancelCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, ScheduledOrderCancelCmd

public class ScheduledOrderCancelCmdImpl
extends ControllerCommandImpl
implements ScheduledOrderCancelCmd

Cancels execution of a recurring order submitted by the OrderSchedule command.


Field Summary
protected static java.lang.String istrCheckParametersFunc
           
protected static java.lang.String istrIsReadyToCallExecuteFunc
           
protected static java.lang.String istrPerformFunc
           
protected static java.lang.String istrSetRequestPropertiesFunc
           
protected static java.lang.String istrThisClass
           
 
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.order.commands.ScheduledOrderCancelCmd
COPYRIGHT, NAME
 
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
 
Fields inherited from interface com.ibm.commerce.command.ECTargetableCommand
COPYRIGHT
 
Constructor Summary
ScheduledOrderCancelCmdImpl()
           
 
Method Summary
 java.lang.Long getJobId()
          Gets scheduler job id which needs to be disabled.
 java.lang.Long getOrderId()
          Gets order identifier
 RemoveJobCmd getRemoveJobCmd()
          Gets the instance of the RemoveJob command.
 AccessVector getResources()
          Gets the access vector accessed by this command.
 java.lang.String getUrl()
          Gets the redirection url to be called when the command completes successfully.
 void performExecute()
          Contains the actual business logic of the command.
protected  void reSet()
           
 void setJobId(java.lang.Long newJobId)
          Sets scheduler job id which needs to be disabled.
 void setOrderId(java.lang.Long newOrderId)
          Sets order identifier
 void setRemoveJobCmd(RemoveJobCmdImpl newRemoveJobCmd)
          Sets the instance of the RemoveJob command.
 void setRequestProperties(TypedProperty aReqParms)
          The WebController calls this method before invoking the execute method in this command to set the request properties for this command.
 void setUrl(java.lang.String astrUrl)
          Sets the redirection url to be called when the command completes successfully.
 void validateParameters()
          Performs server side parameter checking.
 
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, 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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

istrCheckParametersFunc

protected static java.lang.String istrCheckParametersFunc

istrIsReadyToCallExecuteFunc

protected static java.lang.String istrIsReadyToCallExecuteFunc

istrPerformFunc

protected static java.lang.String istrPerformFunc

istrSetRequestPropertiesFunc

protected static java.lang.String istrSetRequestPropertiesFunc

istrThisClass

protected static java.lang.String istrThisClass
Constructor Detail

ScheduledOrderCancelCmdImpl

public ScheduledOrderCancelCmdImpl()
Method Detail

getJobId

public java.lang.Long getJobId()
Gets scheduler job id which needs to be disabled.

getOrderId

public java.lang.Long getOrderId()
Gets order identifier

getRemoveJobCmd

public RemoveJobCmd getRemoveJobCmd()
Gets the instance of the RemoveJob command.

getResources

public AccessVector getResources()
                          throws ECException
Description copied from interface: ECCommand
Gets the access vector accessed by this command. The default implementation returns null indicating that no protectable resource is accessed by this command. It is the responsibilities of the command writer to return the protectable primary resource(s) and the corresponding actions accessed by this command.

Specified by:
getResources in interface ECCommand
Overrides:
getResources in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Returns:
AccessVector - a vector of resource action pairs

getUrl

public java.lang.String getUrl()
Gets the redirection url to be called when the command completes successfully.

performExecute

public void performExecute()
                    throws ECException
Contains the actual business logic of the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

reSet

protected void reSet()

setJobId

public void setJobId(java.lang.Long newJobId)
Sets scheduler job id which needs to be disabled.

setOrderId

public void setOrderId(java.lang.Long newOrderId)
Sets order identifier
Specified by:
setOrderId in interface ScheduledOrderCancelCmd
Following copied from interface: com.ibm.commerce.order.commands.ScheduledOrderCancelCmd
Parameters:
anOrderId - java.util.Integer - order identifier

setRemoveJobCmd

public void setRemoveJobCmd(RemoveJobCmdImpl newRemoveJobCmd)
Sets the instance of the RemoveJob command.

setRequestProperties

public void setRequestProperties(TypedProperty aReqParms)
                          throws ECApplicationException
The WebController calls this method before invoking the execute method in this command to set the request properties for this command.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Following copied from interface: com.ibm.commerce.command.ControllerCommand
Parameters:
requestProperties - com.ibm.commerce.datatype.TypedProperty
Throws:
com.ibm.commerce.exception.ECException. -  

setUrl

public void setUrl(java.lang.String astrUrl)
Sets the redirection url to be called when the command completes successfully.
Specified by:
setUrl in interface ScheduledOrderCancelCmd
Following copied from interface: com.ibm.commerce.order.commands.ScheduledOrderCancelCmd
Parameters:
astrUrl - java.lang.String - redirection url string

validateParameters

public void validateParameters()
                        throws ECException
Performs server side parameter checking.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
ECException. -