com.ibm.commerce.scheduler.commands

Class AddBroadcastJobCmdImpl

  • All Implemented Interfaces:
    AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, AddBroadcastJobCmd, AddJobCmd, 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 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.

    See Also:
    Serialized Form
    • 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.