com.ibm.commerce.scheduler.commands

Class RemoveJobCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.scheduler.commands.RemoveJobCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, RemoveJobCmd, com.ibm.commerce.scheduler.OmitSchedulerJobId, Protectable, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class RemoveJobCmdImpl
extends ControllerCommandImpl
implements RemoveJobCmd

This class removes jobs from the scheduler so that they will no longer be processed.

The parameters handled by this command are as follows.

• jobId (required): This is the job reference number of the scheduled job to remove.
• URL (required): This is the URL to redirect to after the command has finished executing.

This command first validates that the required parameters are specified. Then it takes the specified job and changes its configuration so is has an ACTIVE value of "D". Then the row in the SCHACTIVE and SCHBRDCST tables that are linked to the job are removed.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.scheduler.commands.RemoveJobCmd

defaultCommandClassName, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
RemoveJobCmdImpl() This is the default constructor for this class.

Method Summary

Modifier and Type	Method and Description
AccessVector	getResources() This method gets the resources for the command.
void	performExecute() This method removes the record from the SCHACTIVE table and sets the ACTIVE flag in the SCHCONFIG record to D.
void	setJobRefNum(java.lang.Long jobrefnum) This method 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 them locally in the command.
void	setUrl(java.lang.String url) This method sets the URL to which we should be redirected at the end of the command.
void	validateParameters() This method 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, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

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.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

Constructor Detail

RemoveJobCmdImpl

public RemoveJobCmdImpl()

This is the default constructor for this class. It calls the constructor from the superclass.

Method Detail

getResources

public AccessVector getResources()
                          throws ECException

This method gets the resources for the command. The resource for the command is the store to which the job belongs.

Specified by:

getResources in interface ECCommand

Overrides:

getResources in class AbstractECTargetableCommand

Returns:

This method returns an AccessVector object containing the store to which the job belongs.

Throws:

ECException - This is thrown if there was a problem getting the store of the specified job.

performExecute

public void performExecute()
                    throws ECException

This method removes the record from the SCHACTIVE table and sets the ACTIVE flag in the SCHCONFIG record to D.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException - This is thrown if there was a problem obtaining the record to delete.

setJobRefNum

public void setJobRefNum(java.lang.Long jobrefnum)

This method sets the job reference number for the job to be removed.

Parameters:

jobrefnum - This is the job reference number of the job to remove.

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException

This method extracts the required parameters from the request properties and sets them 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 - This is a TypedProperty object that represents the parameters specified to the command.

Throws:

ECApplicationException - This is thrown if a parameter was not specified.

setUrl

public void setUrl(java.lang.String url)

This method sets the URL to which we should be redirected at the end of the command.

Parameters:

url - This is the redirect URL.

validateParameters

public void validateParameters()
                        throws ECException

This method verifies the values of the parameters specified.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException - This is thrown if the job reference number was missing or if the URL was not specified.