java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.scheduler.commands.RemoveJobCmdImpl
Remove jobs from scheduler so it will not be processed any longer.
The parameters handled by this command are as follows.
The command validates that the required parameters are specified. Then it takes the specified job and changes it configuration so is has an ACTIVE value of "D". Then the row in the SCHACTIVE table and SCHBRDCST table that is linked to the job is removed.
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. RemoveJobCmd |
defaultCommandClassName,
NAME |
Constructor Summary | |
---|---|
RemoveJobCmdImpl() Create the RemoveJob command object. |
Method Summary | |
---|---|
protected
java.lang.Long |
getJobRefNum() Gets the job reference number for the job to be removed. |
AccessVector |
getResources() Returns the resources for the command. |
protected
java.lang.String |
getUrl() Gets the URL to be redirected to when this job finishes execution. |
void |
performExecute() Removes the record from the SCHACTIVE and set the ACTIVE flag in the SCHCONFIG record to D. |
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 |
setUrl(java.lang.String url) Sets the URL to be redirected to at the end of the command. |
void |
validateParameters() Verifies the values of the parameters specified. |
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 RemoveJobCmdImpl()
Method Detail |
---|
protected java.lang.Long getJobRefNum()
public AccessVector getResources() throws ECException
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
- If there was a problem getting the store of the specified
job.protected java.lang.String getUrl()
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
- if there was a problem obtaining the record to delete.public void setJobRefNum(java.lang.Long jobrefnum)
jobrefnum
- the job reference number of the job to
remove.public void setRequestProperties(TypedProperty reqParms) throws ECApplicationException
setRequestProperties
in interface
ControllerCommand
setRequestProperties
in class
ControllerCommandImpl
reqParms
- the parameters specified to the command.
ECApplicationException
- if a parameter was not
specified.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 the job reference number was missing or invalid or if the URL was not
specified.