public interface AddJobCmd extends ControllerCommand
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
static java.lang.String |
defaultCommandClassName
This is the default implementation of this command.
|
static java.lang.String |
NAME
This is the name of this command.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Long |
getJobId()
This method gets the job reference number.
|
java.lang.Long |
getJobInstanceId()
This method gets the job instance number.
|
void |
setApplicationType(java.lang.String ApplicationType)
This method sets the application type.
|
void |
setAttempts(java.lang.Integer attempts)
This method sets the number of retry attempts.
|
void |
setDelay(java.lang.Integer delay)
This method sets the delay time between re-attempts.
|
void |
setHost(java.lang.String host)
This method sets the name of the host where command should be run.
|
void |
setInterval(java.lang.Integer interval)
This method sets the rerun frequency of this job.
|
void |
setName(java.lang.String name)
This method sets the user identity for the execution of the job.
|
void |
setPathInfo(java.lang.String pathInfo)
This method sets the name of the command to execute.
|
void |
setQueryString(java.lang.String parameters)
This method sets the query string associated with the job.
|
void |
setSequence(java.lang.Integer policy)
This method sets the sequence.
|
void |
setStartTime(java.sql.Timestamp startTime)
This method sets the start time of the job execution.
|
void |
setStoreId(java.lang.Integer storeId)
This method sets the store id of the scheduled job.
|
void |
setUrl(java.lang.String url)
This method sets the URL to which we should be redirected at the end of the command.
|
void |
setUserRefNum(java.lang.Long refnum)
This method sets the member id of the user identity for the execution of the job.
|
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
fulfills, getOwner
static final java.lang.String COPYRIGHT
static final java.lang.String NAME
static final java.lang.String defaultCommandClassName
java.lang.Long getJobId()
java.lang.Long getJobInstanceId()
Long
object that represents the job's instance number.
This indicates when the job needs to be executed.void setApplicationType(java.lang.String ApplicationType)
applicationType
- This is the application type of the job.void setAttempts(java.lang.Integer attempts)
attemps
- This is the number of times the command execution should be attempted.void setDelay(java.lang.Integer delay)
delay
- This is the delay in seconds between a failed run and re-execution of the command.void setHost(java.lang.String host)
host
- This is the scheduler instance that should run this job. A null value means any scheduler instance.void setInterval(java.lang.Integer interval)
interval
- This is the time in seconds between re-executions of the job. This must be a value
greater than or equal to 0. 0 means the job will only be executed once.void setName(java.lang.String name)
name
- This is the logon id of the user.void setPathInfo(java.lang.String pathInfo)
pathInfo
- the name of the command.void setQueryString(java.lang.String parameters)
n1=v1&n2=v2
indicates
that 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
- This is a String
object that represents the parameters passed to the command when executing.void setSequence(java.lang.Integer policy)
policy
- An Integer
object that represents the policy.void setStartTime(java.sql.Timestamp startTime)
startTime
- This is the start time of the job.void setUrl(java.lang.String url)
url
- This is the redirect URL.void setUserRefNum(java.lang.Long refnum)
refnum
- This is the member id of the user.void setStoreId(java.lang.Integer storeId)
storeId
- This is the id of the store on whose behalf the job will be executed.