com.ibm.commerce.scheduler.commands
Interface AddJobCmd

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

public interface AddJobCmd
extends ControllerCommand

Add a job to scheduler table.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 java.lang.Long getJobId()
          Gets the job id.
 java.lang.Long getJobInstanceId()
          Gets the job instance id.
 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 frquency to rerun of this job.
 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 setSequence(java.lang.Integer policy)
          Sets the sequence.
 void setStartTime(java.sql.Timestamp startTime)
          Sets the start time.
 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
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, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName

NAME

public static final java.lang.String NAME
Method Detail

getJobId

public java.lang.Long getJobId()
Gets the job id.

Returns:
Long

getJobInstanceId

public java.lang.Long getJobInstanceId()
Gets the job instance id.

Returns:
Long

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.

setHost

public void setHost(java.lang.String host)
Sets the name of the host where command should be run.

setInterval

public void setInterval(java.lang.Integer interval)
Sets the frquency to rerun of this job.
Parameters:
interval - Integer - interval in units of seconds.

setName

public void setName(java.lang.String name)
Sets the name of user.

setPathInfo

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

setQueryString

public void setQueryString(java.lang.String parameters)
Sets the query string associated with the job.

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.

Parameters:
startTiem - Timestamp

setUrl

public void setUrl(java.lang.String url)
Sets the url to be redirected to at the end of the command.

Parameters:
url - String - url

setUserRefNum

public void setUserRefNum(java.lang.Long refnum)
Sets the user Id.

Parameters:
Long -