Field Detail

• COPYRIGHT

  static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

• NAME

  static final java.lang.String NAME
  

  This is the name of this command.

  See Also:

  Constant Field Values

• defaultCommandClassName

  static final java.lang.String defaultCommandClassName
  

  This is the default implementation of this command.

  See Also:

  Constant Field Values

Method Detail

• getJobId

  java.lang.Long getJobId()
  

  This method gets the job reference number.

  Returns:

  This method returns the job reference number of the added job.

• getJobInstanceId

  java.lang.Long getJobInstanceId()
  

  This method gets the job instance number.

  Returns:

  This method returns a Long object that represents the job's instance number. This indicates when the job needs to be executed.

• setApplicationType

  void setApplicationType(java.lang.String ApplicationType)
  

  This method sets the application type.

  Parameters:

  applicationType - This is the application type of the job.

• setAttempts

  void setAttempts(java.lang.Integer attempts)
  

  This method sets the number of retry attempts.

  Parameters:

  attemps - This is the number of times the command execution should be attempted.

• setDelay

  void setDelay(java.lang.Integer delay)
  

  This method sets the delay time between re-attempts.

  Parameters:

  delay - This is the delay in seconds between a failed run and re-execution of the command.

• setHost

  void setHost(java.lang.String host)
  

  This method sets the name of the host where command should be run.

  Parameters:

  host - This is the scheduler instance that should run this job. A null value means any scheduler instance.

• setInterval

  void setInterval(java.lang.Integer interval)
  

  This method sets the rerun frequency of this job.

  Parameters:

  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.

• setName

  void setName(java.lang.String name)
  

  This method sets the user identity for the execution of the job.

  Parameters:

  name - This is the logon id of the user.

• setPathInfo

  void setPathInfo(java.lang.String pathInfo)
  

  This method sets the name of the command to execute.

  Parameters:

  pathInfo - the name of the command.

• setQueryString

  void setQueryString(java.lang.String parameters)
  

  This method 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 query string. This means that 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:

  parameters - This is a String object that represents the parameters passed to the command when executing.

• setSequence

  void setSequence(java.lang.Integer policy)
  

  This method sets the sequence. It is the policy for handling missed runs. The default is 0, meaning that missed jobs will all be skipped except for one.

  Parameters:

  policy - An Integer object that represents the policy.

• setStartTime

  void setStartTime(java.sql.Timestamp startTime)
  

  This method sets the start time of the job execution.

  Parameters:

  startTime - This is the start time of the job.

• setUrl

  void setUrl(java.lang.String url)
  

  This method sets the URL to which we should be redirected at the end of the command.

  Parameters:

  url - This is the redirect URL.

• setUserRefNum

  void setUserRefNum(java.lang.Long refnum)
  

  This method sets the member id of the user identity for the execution of the job.

  Parameters:

  refnum - This is the member id of the user.

• setStoreId

  void setStoreId(java.lang.Integer storeId)
  

  This method sets the store id of the scheduled job.

  Parameters:

  storeId - This is the id of the store on whose behalf the job will be executed.