com.ibm.commerce.scheduler.commands
Interface AddBroadcastJobCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand
All Known Implementing Classes:
AddBroadcastJobCmdImpl

public interface AddBroadcastJobCmd
extends ControllerCommand

Adds a new broadcast job to the Commerce Server's scheduler.


Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          The default implementation of this command.
static java.lang.String NAME
          The name of this command.
static java.lang.String URLNAME
          The defined command name found in the url registry.
 
Method Summary
 java.lang.Long getJobId()
          Gets the job id.
 java.lang.Long getJobInstanceId()
          Gets the job instance id.
 void setName(java.lang.String name)
          Sets the name of user.
 void setPathInfo(java.lang.String pathInfo)
          Sets the name of the command to be added to the scheduler.
 void setQueryString(java.lang.String parameters)
          Sets the query string associated with the job.
 void setUrl(java.lang.String url)
          Sets the url to be redirected to at the end of the command.
 void setUserRefNum(java.lang.Long refnum)
          Sets the user Id.
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this command.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation of this command.
See Also:
Constant Field Values

URLNAME

public static final java.lang.String URLNAME
The defined command name found in the url registry.
See Also:
Constant Field Values
Method Detail

getJobId

public java.lang.Long getJobId()
Gets the job id.
Returns:
The job reference number of the new job.

getJobInstanceId

public java.lang.Long getJobInstanceId()
Gets the job instance id.
Returns:
The instance reference number of the record to indicate when the job needs to run.

setName

public void setName(java.lang.String name)
Sets the name of user.
Parameters:
name - the logon id of the user to run the command as.

setPathInfo

public void setPathInfo(java.lang.String pathInfo)
Sets the name of the command to be added to the scheduler.
Parameters:
pathInfo - the command to execute.

setQueryString

public void setQueryString(java.lang.String parameters)
Sets the query string associated with the job.
Parameters:
parameters - the parameters to pass to the command when it is executed.

setUrl

public void setUrl(java.lang.String url)
Sets the url to be redirected to at the end of the command.
Parameters:
url - the URL to redirect to after the broadcast job is added.

setUserRefNum

public void setUserRefNum(java.lang.Long refnum)
Sets the user Id.
Parameters:
refnum - the member id of user which will run the command.