com.ibm.commerce.order.commands
Interface OrderScheduleCmd

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

public interface OrderScheduleCmd
extends ControllerCommand

Submits a recurring order, which will be processed by the job scheduler.


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 setHost(java.lang.String astrHost)
          Sets the hostname responsible for processing an order.
 void setInterval(java.lang.Integer anInterval)
          Sets the number of seconds between successive executions of this order.
 void setOrderId(java.lang.Long orderNumber)
          Sets the order which needs to be processed as a recurring order.
 void setOutOrderName(java.lang.String[] aarrOutOrderName)
          Sets the names of the name-value pairs to be added to the redirection URL.
 void setRecoveryAttempts(java.lang.Integer anRecAttempts)
          Sets the number of times the job scheduler will retry processing the order should order processing failure occur.
 void setRecoveryDelay(java.lang.Integer anRecDelay)
          Sets the amount of time (in seconds) before order processing is retried in case of order processing failure.
 void setStartTime(java.lang.String astrStartTime)
          The time at which the first execution of this order should occur in the format YYYY:MM:DD:hh:mm:ss.
 
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

setHost

public void setHost(java.lang.String astrHost)
Sets the hostname responsible for processing an order. Use this method when job scheduler instances are running on multiple hosts and processing this order needs to be restricted to a certain host.
Parameters:
astrHost - java.lang.String - host name

setInterval

public void setInterval(java.lang.Integer anInterval)
Sets the number of seconds between successive executions of this order.
Parameters:
anInterval - java.lang.Integer - interval in seconds

setOrderId

public void setOrderId(java.lang.Long orderNumber)
Sets the order which needs to be processed as a recurring order.
Parameters:
orderNumber - java.lang.Long - order identifier

setOutOrderName

public void setOutOrderName(java.lang.String[] aarrOutOrderName)
Sets the names of the name-value pairs to be added to the redirection URL. The value of each added name-value pair is the reference number of a scheduled order model.

setRecoveryAttempts

public void setRecoveryAttempts(java.lang.Integer anRecAttempts)
Sets the number of times the job scheduler will retry processing the order should order processing failure occur. When setting the number of recovery attempts you must also set the recovery delay (setRecoveryDelay())
Parameters:
anRecAttempts - java.lang.Integer - number of recovery attempts

setRecoveryDelay

public void setRecoveryDelay(java.lang.Integer anRecDelay)
Sets the amount of time (in seconds) before order processing is retried in case of order processing failure. When setting the recovery delay you must also set the number of recovery attempts (setRecoveryAttempts())
Parameters:
anRecDelay - java.lang.Integer - number of seconds to delay between retrying to recover from order processing failure

setStartTime

public void setStartTime(java.lang.String astrStartTime)
The time at which the first execution of this order should occur in the format YYYY:MM:DD:hh:mm:ss. Only hh:mm:ss is mandatory.
Parameters:
astrStartTime - java.lang.String - start time for order processing