com.ibm.commerce.scheduler.commands
Class AddBroadcastJobCmdImpl
java.lang.Object
|
+--CacheableCommandImpl
|
+--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,
AddBroadcastJobCmd,
AddJobCmd,
ControllerCommand,
ECCommand,
ECTargetableCommand
- public class AddBroadcastJobCmdImpl
- extends
AddJobCmdImpl
- implements
AddBroadcastJobCmd
Adds a new broadcast job to the Commerce Server's scheduler.
The parameters passed to the command are:
- pathInfo (required): the command to execute.
- URL (required): the URL to redirect to after the command is executed.
- queryString (optional): 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 no parameters are passed
to the executing command.
- name (optional): the user to run the command as. If no value is specified
the 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 schedule job is handle by the AddJobCmdImpl
and this command
just control the configuration that is specified to the schedule job.
- See Also:
- Serialized
Form
Field Summary |
static java.lang.String |
COPYRIGHT
IBM copyright notice field. |
Method Summary |
void |
setRequestProperties(
TypedProperty reqParms)
This method extracts the required parameters from the request
properties and sets it locally in the command. |
void |
validateParameters()
Validates the parameters passed to the command and sets other
schedule job configuration parameters that is 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
com.ibm.commerce.command.
AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
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.
ECCommand |
checkIsAllowed,
checkResourcePermission,
createCommandExecutionEvent,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
performExecute,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- IBM copyright notice field.
- See Also:
-
Constant Field Values
AddBroadcastJobCmdImpl
public AddBroadcastJobCmdImpl()
- Creates the AddBroadcastJob command object.
validateParameters
public void validateParameters()
throws ECException
- Validates the parameters passed to the command and sets other schedule job
configuration parameters that is associated with a broadcast job.
-
- Specified by:
-
validateParameters
in interface
ECCommand
- Overrides:
-
validateParameters
in class
AddJobCmdImpl
-
- Throws:
-
ECException
- if there is 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 it locally in the command.
-
- Specified by:
-
setRequestProperties
in interface
ControllerCommand
- Overrides:
-
setRequestProperties
in class
AddJobCmdImpl
-
- Parameters:
reqParms
- the parameters passed to the command.
- Throws:
-
ECException
- if there is either missing or incorrect parameter values passed to the
command.