java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.scheduler.commands.CleanJobCmdImpl
Remove job entries from scheduler status table if the job entry is completed.
The command exceptions the following parameters:
The command first verifies the values specified. Once the parameters are verified the status in the SCHSTATUS and SCHBRDCST tables that have an end time that is before the specified end time. If a job number is specified, on the status for that particular job is removed and if no job number is specified, then all job status will be removed. The response properties will contain the appropriate information to redirect to the specified URL after execution.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM Copyright notice field. |
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.scheduler.commands. CleanJobCmd |
defaultCommandClassName,
NAME |
Constructor Summary | |
---|---|
CleanJobCmdImpl() Creates the CleanJob command object. |
Method Summary | |
---|---|
protected
static java.sql.Timestamp |
convertTime(java.lang.String time) Convert the input time value to a Timestamp. |
java.sql.Timestamp |
getEndTime() Gets the end time of the job status to clean. |
protected
java.lang.Long |
getJobRefNum() Gets the job reference number for the job to be removed. |
AccessVector |
getResources() Returns the store the owns the job to be cleaned. |
protected
java.lang.String |
getStringEndTime() Gets the end time of the status to clean. |
protected
java.lang.String |
getUrl() Gets the URL to be redirected to at the end of the command. |
void |
performExecute() Find all the status records for the specified job that is completed and has an end time less before the specified value. |
void |
setEndTime(java.sql.Timestamp endTime) Sets the time value which indicates the status records that should be deleted. |
void |
setJobRefNum(java.lang.Long jobrefnum) Sets the job reference number for the job to be removed. |
void |
setRequestProperties(
TypedProperty reqParms) This method extracts the required parameters from the request properties and sets it locally in the command. |
void |
setStringEndTime(java.lang.String endTime) Sets the time criteria used to clean job status entries. |
void |
setUrl(java.lang.String url) Sets the URL to be redirected to at the end of the command. |
void |
validateParameters() Validates the parameters passed to the command. |
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,
reset,
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 |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public CleanJobCmdImpl()
Method Detail |
---|
protected static java.sql.Timestamp convertTime(java.lang.String time) throws ECException
time
- input time valueECException
public java.sql.Timestamp getEndTime()
protected java.lang.Long getJobRefNum()
public AccessVector getResources() throws ECException
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
- if there is a problem obtaining the store id of the job.protected java.lang.String getStringEndTime()
protected java.lang.String getUrl()
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
- if there is a problem removing or finding the job status
records.public void setEndTime(java.sql.Timestamp endTime)
public void setJobRefNum(java.lang.Long jobrefnum)
jobrefnum
- the job to clean.public void setRequestProperties(TypedProperty reqParms) throws ECApplicationException
setRequestProperties
in interface
ControllerCommand
setRequestProperties
in class
ControllerCommandImpl
reqParms
- the parameters of the command.
ECApplicationException
- if there was an invalid or missing
parameter.public void setStringEndTime(java.lang.String endTime)
public void setUrl(java.lang.String url)
url
- the URL to redirect to.public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException
- if a required parameter is missing or a specified parameter is
invalid.