com.ibm.commerce.scheduler.commands
Class RemoveJobCmdImpl

com.ibm.commerce.command.AbstractECTargetableCommand
  |
  +--com.ibm.commerce.command.ControllerCommandImpl
        |
        +--com.ibm.commerce.scheduler.commands.RemoveJobCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, RemoveJobCmd

public class RemoveJobCmdImpl
extends ControllerCommandImpl
implements RemoveJobCmd

Remove jobs from scheduler. No longer schedule that job.


Field Summary
static java.lang.String COPYRIGHT
           
 
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()
          RemoveJobCmdImpl constructor comment.
 
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()
          This is the real function part of the RemoveJob command - remove a job related information from scheduler, set deactive flag in the scheduler config table and remove all job entries related with that job which are not run from scheduler status table.
 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()
          Checks the validity of the parameters
 
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

COPYRIGHT

public static final java.lang.String COPYRIGHT
Constructor Detail

RemoveJobCmdImpl

public RemoveJobCmdImpl()
RemoveJobCmdImpl constructor comment.
Method Detail

getJobRefNum

protected java.lang.Long getJobRefNum()
Gets the job reference number for the job to be removed.

getResources

public AccessVector getResources()
                          throws ECException
Returns the resources for the command.
Specified by:
getResources in interface ECCommand
Overrides:
getResources in class AbstractECTargetableCommand
Returns:
com.ibm.commerce.accesscontrol.AccessVector
Throws:
ECException - The exception description.

getUrl

protected java.lang.String getUrl()
Gets the url to be redirected to when this job finishes execution.

performExecute

public void performExecute()
                    throws ECException
This is the real function part of the RemoveJob command - remove a job related information from scheduler, set deactive flag in the scheduler config table and remove all job entries related with that job which are not run from scheduler status table.
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.

setJobRefNum

public void setJobRefNum(java.lang.Long jobrefnum)
Sets the job reference number for the job to be removed.

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException
This method extracts the required parameters from the request properties and sets it locally in the command. It throws an ECApplicationException if a required parameter is missing.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Parameters:
reqParms - com.ibm.commerce.datatype.TypedProperty
Throws:
ECApplicationException -  

setUrl

public void setUrl(java.lang.String url)
Sets the url to be redirected to at the end of the command.

Parameters:
url - String - url

validateParameters

public void validateParameters()
                        throws ECException
Checks the validity of the parameters
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
ECException. -