AddBroadcastJobCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.ControllerCommandImpl
    - - com.ibm.commerce.scheduler.commands.AddJobCmdImpl
      - com.ibm.commerce.scheduler.commands.AddBroadcastJobCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, AddBroadcastJobCmd, AddJobCmd, Protectable, 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 AddBroadcastJobCmdImpl
extends AddJobCmdImpl
implements AddBroadcastJobCmd
```
This class adds a new broadcast job to the WebSphere Commerce Server's scheduler.

The parameters passed to the command are:
- pathInfo (required): This is the command to execute.
- URL (required): This is the URL to which we are redirected after the command is executed.
- queryString (optional): This represents the parameters passed to the command. These will be in the same format as the query string of a URL request. If no value is specified, the default value is null which represents that no parameters are passed to the executing command.
- name (optional): This is the user as whom the command is to be run. If no value is specified the current user adding the broadcast job is used.
This command sets and verifies the configuration needed to create a broadcast job. Only the parameters specified above are configurable and the rest of the configuration will be set in this command. The actual creation of the scheduled job is handled by the AddJobCmdImpl class and this command just controls the configuration that is specified to the scheduled job.

Field Summary

Fields
Modifier and Type Field and Description

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.AddBroadcastJobCmd
  defaultCommandClassName, NAME, URLNAME
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID
- Fields inherited from interface com.ibm.commerce.scheduler.commands.AddJobCmd
  defaultCommandClassName, NAME

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

AddBroadcastJobCmdImpl()
This is the default constructor for this class.

Constructors
Constructor and Description
`AddBroadcastJobCmdImpl()` This is the default constructor for this class.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`setRequestProperties(TypedProperty reqParms)` This method extracts the required parameters from the request properties and sets them locally in the command.
`void`	`validateParameters()` This method validates the parameters passed to the command and sets other schedule job configuration parameters that are associated with a broadcast job.

Methods inherited from class com.ibm.commerce.scheduler.commands.AddJobCmdImpl
convertTime, getApplicationType, getAttempts, getCheckCommandId, getDelay, getEndTime, getErrorUrl, getHost, getInterfaceName, getInterval, getJobId, getJobInstanceId, getName, getPathInfo, getPriority, getQueryString, getResources, getSequence, getStartTime, getStoreId, getStringEndTime, getStringStartTime, getUrl, getUserRefNum, performExecute, setApplicationType, setAttempts, setCheckCommandId, setDelay, setEndTime, setErrorUrl, setHost, setInterfaceName, setInterval, setJobId, setJobInfo, setName, setPathInfo, setPriority, setQueryString, setSequence, setStartTime, setStoreId, setStringEndTime, setStringStartTime, setUrl, setUserRefNum

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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.scheduler.commands.AddBroadcastJobCmd
getJobId, getJobInstanceId, setName, setPathInfo, setQueryString, setUrl, setUserRefNum

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, performExecute, 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, getResources, getStoreId, getUser, getUserId, performExecute, 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
  - AddBroadcastJobCmdImpl
```
public AddBroadcastJobCmdImpl()
```
    This is the default constructor for this class. It calls the constructor from the superclass.
- Method Detail
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    This method validates the parameters passed to the command and sets other schedule job configuration parameters that are associated with a broadcast job.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AddJobCmdImpl
    
    Throws:
    
    ECException - This is thrown if there are either missing or invalid parameters passed to the command.
  - setRequestProperties
```
public void setRequestProperties(TypedProperty reqParms)
                          throws ECException
```
    This method extracts the required parameters from the request properties and sets them locally in the command.
    
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class AddJobCmdImpl
    
    Parameters:
    
    reqParms - This is a TypedProperty object that represents the parameters passed to the command.
    
    Throws:
    
    ECException - This is thrown if there is either missing or incorrect parameter values passed to the command.

Class AddBroadcastJobCmdImpl

Field Summary

Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

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

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

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

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.scheduler.commands.AddJobCmdImpl

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.scheduler.commands.AddBroadcastJobCmd

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

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

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

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

Methods inherited from interface com.ibm.commerce.command.AccCommand

Methods inherited from interface com.ibm.commerce.command.ECCommand

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

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

Field Detail

COPYRIGHT

Constructor Detail

AddBroadcastJobCmdImpl

Method Detail

validateParameters

setRequestProperties