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
public static final java.lang.String NAME
public static final java.lang.String defaultCommandClassName
Method Detail |
---|
public java.lang.Long getJobId()
public java.lang.Long getJobInstanceId()
public void setApplicationType(java.lang.String ApplicationType)
public void setAttempts(java.lang.Integer attempts)
public void setDelay(java.lang.Integer delay)
delay
- the delay in seconds when to re-execute the command
incase of a failed run.public void setHost(java.lang.String host)
host
- the scheduler instance which should run this job. A
null value means any scheduler instance.public void setInterval(java.lang.Integer interval)
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.public void setName(java.lang.String name)
name
- the logon id of the user.public void setPathInfo(java.lang.String pathInfo)
pathInfo
- the name of the command.public void setQueryString(java.lang.String parameters)
parameters
- the parameters passed to the command when
executing.public void setSequence(java.lang.Integer policy)
policy
- Integerpublic void setStartTime(java.sql.Timestamp startTime)
startTime
- the start time of the job.public void setUrl(java.lang.String url)
url
- the URL to redirect to.public void setUserRefNum(java.lang.Long refnum)
refnum
- the member id of the user.