java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.order.commands.OrderScheduleCmdImpl
Submits a recurring order, which will be processed by the job scheduler.
Field Summary |
---|
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. OrderScheduleCmd |
COPYRIGHT,
NAME |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand |
COPYRIGHT |
Constructor Summary | |
---|---|
OrderScheduleCmdImpl() |
Method Summary | |
---|---|
AddJobCmd |
getAddJobCmd() Gets AddJob cmd instance. |
java.lang.String |
getHost() Gets the hostname responsible for processing an order. |
java.lang.Integer |
getInterval() Gets the number of seconds between successive executions of this order. |
java.lang.Long |
getOrderId() Gets the order which needs to be processed as a recurring order. |
java.lang.String[] |
getOutOrderName() Gets the names of the name-value pairs to be added to the redirection URL. |
java.lang.Integer |
getRecoveryAttempts() Gets the number of times the job scheduler will retry processing the order should order processing failure occur. |
java.lang.Integer |
getRecoveryDelay() Gets the amount of time (in seconds) before order processing is retried in case of order processing failure. |
AccessVector |
getResources() Gets the resources. |
java.lang.String |
getStartTime() The time at which the first execution of this order should occur. |
java.lang.String |
getUrl() Gets redirection URL. |
void |
performExecute() Contains the actual business logic of the command. |
void |
reset() This method should be called after a command has been executed to reset its state variables. |
void |
setAddJobCmd(
AddJobCmdImpl newAddJobCmd) Sets AddJob cmd instance. |
void |
setHost(java.lang.String newHost) Sets the hostname responsible for processing an order. |
void |
setInterval(java.lang.Integer newInterval) Sets the number of seconds between successive executions of this order. |
void |
setOrderId(java.lang.Long newOrderId) Sets the order which needs to be processed as a recurring order. |
void |
setOutOrderName(java.lang.String[] newOutOrderName) Sets the names of the name-value pairs to be added to the redirection URL. |
void |
setRecoveryAttempts(java.lang.Integer newRecoveryAttempts) Sets the number of times the job scheduler will retry processing the order should order processing failure occur. |
void |
setRecoveryDelay(java.lang.Integer newRecoveryDelay) Sets the amount of time (in seconds) before order processing is retried in case of order processing failure. |
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 |
setStartTime(java.lang.String newStartTime) The time at which the first execution of this order should occur in the format YYYY:MM:DD:hh:mm:ss. |
void |
setUrl(java.lang.String astrUrl) Sets redirection URL. |
void |
validateParameters() Performs server side parameter checking. |
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
getViewInputProperties,
isGeneric,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. ControllerCommand |
checkPermission,
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,
getResourceOwners,
setAccCheck,
setForUserId,
setOwner |
Methods inherited from interface com.ibm.commerce.command. ECCommand |
checkIsAllowed,
checkResourcePermission,
createCommandExecutionEvent,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Constructor Detail |
---|
public OrderScheduleCmdImpl()
Method Detail |
---|
public AddJobCmd getAddJobCmd()
public java.lang.String getHost()
public java.lang.Integer getInterval()
public java.lang.Long getOrderId()
public java.lang.String[] getOutOrderName()
public java.lang.Integer getRecoveryAttempts()
public java.lang.Integer getRecoveryDelay()
public AccessVector getResources() throws ECException
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
public java.lang.String getStartTime()
public java.lang.String getUrl()
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
public void reset()
reset
in class
AbstractECTargetableCommand
public void setAddJobCmd(AddJobCmdImpl newAddJobCmd)
newAddJobCmd
- add job command.public void setHost(java.lang.String newHost)
setHost
in interface
OrderScheduleCmd
newHost
- host.public void setInterval(java.lang.Integer newInterval)
setInterval
in interface
OrderScheduleCmd
newInterval
- java.lang.Integer - interval in
secondspublic void setOrderId(java.lang.Long newOrderId)
setOrderId
in interface
OrderScheduleCmd
newOrderId
- java.lang.Long - order
identifierpublic void setOutOrderName(java.lang.String[] newOutOrderName)
setOutOrderName
in interface
OrderScheduleCmd
newOutOrderName
- out order name.public void setRecoveryAttempts(java.lang.Integer newRecoveryAttempts)
setRecoveryAttempts
in interface
OrderScheduleCmd
newRecoveryAttempts
- java.lang.Integer - number of recovery
attemptspublic void setRecoveryDelay(java.lang.Integer newRecoveryDelay)
setRecoveryDelay
in interface
OrderScheduleCmd
newRecoveryDelay
- java.lang.Integer - number of seconds to
delay between retrying to recover from order processing
failurepublic void setRequestProperties(TypedProperty aReqParms) throws ECException
setRequestProperties
in interface
ControllerCommand
setRequestProperties
in class
ControllerCommandImpl
aReqParms
- request properties.ECException
public void setStartTime(java.lang.String newStartTime)
setStartTime
in interface
OrderScheduleCmd
newStartTime
- java.lang.String - start time for order
processingpublic void setUrl(java.lang.String astrUrl)
astrUrl
- URL.public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException