com.ibm.commerce.scheduler.commands
Interface AddJobCmd

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

public interface AddJobCmd
extends ControllerCommand

Add a 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.
 
Method Summary
 java.lang.Long getJobId()
          Returns the job reference number.
 java.lang.Long getJobInstanceId()
          Returns the job instance number.
 void setApplicationType(java.lang.String ApplicationType)
          Sets the application type.
 void setAttempts(java.lang.Integer attempts)
          Sets the number of retry attempts.
 void setDelay(java.lang.Integer delay)
          Sets the delay time between re-attempts.
 void setHost(java.lang.String host)
          Sets the name of the host where command should be run.
 void setInterval(java.lang.Integer interval)
          Sets the frequency to rerun of this job.
 void setName(java.lang.String name)
          Sets the name of user identity for the execution of the job.
 void setPathInfo(java.lang.String pathInfo)
          Sets the name of the command to execute.
 void setQueryString(java.lang.String parameters)
          Sets the query string associated with the job.
 void setSequence(java.lang.Integer policy)
          Sets the sequence.
 void setStartTime(java.sql.Timestamp startTime)
          Sets the start time when to start executing 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 member id of the user identify for the execution of the job.
 
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
Method Detail

getJobId

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

getJobInstanceId

public java.lang.Long getJobInstanceId()
Returns the job instance number.
Returns:
The job's instance number that indicates when the job needs to be executed.

setApplicationType

public void setApplicationType(java.lang.String ApplicationType)
Sets the application type.

setAttempts

public void setAttempts(java.lang.Integer attempts)
Sets the number of retry attempts.

setDelay

public void setDelay(java.lang.Integer delay)
Sets the delay time between re-attempts.
Parameters:
delay - the delay in seconds when to re-execute the command incase of a failed run.

setHost

public void setHost(java.lang.String host)
Sets the name of the host where command should be run.
Parameters:
host - the scheduler instance which should run this job. A null value means any scheduler instance.

setInterval

public void setInterval(java.lang.Integer interval)
Sets the frequency to rerun of this job.
Parameters:
interval - the time in seconds when the job should be re-executed. Must be a value greater or equal to 0. 0 means the job will only be executed once.

setName

public void setName(java.lang.String name)
Sets the name of user identity for the execution of the job.
Parameters:
name - the logon id of the user.

setPathInfo

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

setQueryString

public void setQueryString(java.lang.String parameters)
Sets the query string associated with the job. This will be translated into parameters passed to the command when executing. The format is similar to a URL querystring which means that n1=v1&n2=v2 means two parameters will be passed to the command, one being n1 with a value of v1 and the other n2 with a value of v2.
Parameters:
parameters - the parameters passed to the command when executing.

setSequence

public void setSequence(java.lang.Integer policy)
Sets the sequence. The policy for handling missed runs. The default is 0, meaning that missed job will all be skipped except for one.
Parameters:
policy - Integer

setStartTime

public void setStartTime(java.sql.Timestamp startTime)
Sets the start time when to start executing the job.
Parameters:
startTime - the start time of the job.

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.

setUserRefNum

public void setUserRefNum(java.lang.Long refnum)
Sets the member id of the user identify for the execution of the job.
Parameters:
refnum - the member id of the user.