ScheduledJob (ATG Java API)

java.lang.Object
- atg.service.scheduler.ScheduledJob

```
public class ScheduledJob
extends java.lang.Object
```
A ScheduledJob represents all the information about a job in the scheduler. This includes the job's id, name, description, Schedule, and source, and separate thread flag. When the job occurs, this object is passed to the Schedulable object that is to receive the job.
- jobId - this is the id assigned to the job when it is added to the Scheduler. This id is used when asking the Scheduler to find or remove a job. Only the Scheduler should be setting the jobId.
- jobName - this is a short name for the job. This name is displayed within an administrative interface, but is not otherwise interpreted by the Scheduler. The Schedulable object handling the job may wish to interpret this name to distinguish the job from other possible jobs.
- jobDescription - this is a more complete description of the job. This is displayed within an administrative interface, but is not otherwise interpreted by the Scheduler.
- sourceName - this is the name of the object that scheduled the job. This is displayed within an administrative interface, but is not otherwise interpreted by the Scheduler.
- schedule - this is the Schedule that the Scheduler is using to determine when the job is to occur.
- threadMethod - this indicates what threading model should be used to execute the scheduled job. This should be specified with one of the following values:
  - ScheduledJob.SCHEDULER_THREAD - the job is run in the Scheduler's own Thread. This is the most efficient thread method, but it does block the Scheduler from performing any other jobs until the job is complete, so it should only be used for jobs that don't take a long time to run. Jobs that use I/O should probably avoid using this option.
  - ScheduledJob.SEPARATE_THREAD - each time the job is triggered, a new thread is created to run the job. The thread is destroyed when the job completes. Note that if a job is set to run periodically at a rate that is faster than the job itself can run, then new threads will keep getting created to handle those jobs.
  - ScheduledJob.REUSED_THREAD - a separate thread is created to handle the job. Whenever the job is triggered, that thread is directed to run the job. When the job completes, the thread stays around waiting for the next time the job is triggered. If the job is still running and the scheduler sees that it is time to trigger the job again, the scheduler will not bother to do so and will wait until the next time around. With this method, the scheduler thread is not blocked by executing jobs, and threads don't multiply out of control if the job is triggering too quickly.
- transactional - flag indicating if each occurrence of this job is to be executed in its own transaction. The scheduler will take care of creating and committing the transaction. Default is true. If false, the scheduled job will operate without a transactional context.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`static int`	`REUSED_THREAD`
`static java.lang.String`	`REUSED_THREAD_STRING` String that corresponds to reused thread.
`static int`	`SCHEDULER_THREAD`
`static java.lang.String`	`SCHEDULER_THREAD_STRING` String that corresponds to scheduler thread.
`static int`	`SEPARATE_THREAD`
`static java.lang.String`	`SEPARATE_THREAD_STRING` String that corresponds to separate thread.

Constructor Summary

Constructors
Constructor and Description
`ScheduledJob(java.lang.String pJobName, java.lang.String pJobDescription, java.lang.String pSourceName, Schedule pSchedule, Schedulable pSchedulable, boolean pSeparateThread)` Constructs a new ScheduledJobImpl
`ScheduledJob(java.lang.String pJobName, java.lang.String pJobDescription, java.lang.String pSourceName, Schedule pSchedule, Schedulable pSchedulable, int pThreadMethod)` Constructs a new ScheduledJobImpl
`ScheduledJob(java.lang.String pJobName, java.lang.String pJobDescription, java.lang.String pSourceName, Schedule pSchedule, Schedulable pSchedulable, int pThreadMethod, boolean pTransactional)` Constructs a new ScheduledJobImpl

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getJobDescription()` Returns the description of the job
`int`	`getJobId()` Returns the id of the job
`java.lang.String`	`getJobName()` Returns the name of the job
`long`	`getLastJobTime()` Returns the last time the job was run, or 0 if the job has not yet been run.
`long`	`getNextJobTime()` Return the next job time, calculated from the last job time.
`int`	`getRunCount()` Returns the number of times the job has been run
`Schedulable`	`getSchedulable()` Returns the Schedulable object that will be notified of this job.
`Schedule`	`getSchedule()` Returns the Schedule for this job
`java.lang.String`	`getSourceName()` Returns the source name of the job
`static java.lang.String`	`getStringForThreadMethod(int pThreadMethod)` Return the string that corresponds to pThreadMethod.
`int`	`getThreadMethod()` Returns the threading method used for the job.
`static int`	`getThreadMethodForString(java.lang.String pThreadMethod)` Return the thread method integer that corresponds to the pThreadMethod string.
`boolean`	`getTransactional()` Returns the flag indicating if the job should be running in its own transaction context.
`void`	`setJobId(int pJobId)` Sets the id of the job.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
  - SCHEDULER_THREAD
```
public static final int SCHEDULER_THREAD
```
    See Also:
    Constant Field Values
  - SEPARATE_THREAD
```
public static final int SEPARATE_THREAD
```
    See Also:
    Constant Field Values
  - REUSED_THREAD
```
public static final int REUSED_THREAD
```
    See Also:
    Constant Field Values
  - SCHEDULER_THREAD_STRING
```
public static final java.lang.String SCHEDULER_THREAD_STRING
```
    String that corresponds to scheduler thread.
    
    See Also:
    Constant Field Values
  - SEPARATE_THREAD_STRING
```
public static final java.lang.String SEPARATE_THREAD_STRING
```
    String that corresponds to separate thread.
    
    See Also:
    Constant Field Values
  - REUSED_THREAD_STRING
```
public static final java.lang.String REUSED_THREAD_STRING
```
    String that corresponds to reused thread.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - ScheduledJob
```
public ScheduledJob(java.lang.String pJobName,
            java.lang.String pJobDescription,
            java.lang.String pSourceName,
            Schedule pSchedule,
            Schedulable pSchedulable,
            boolean pSeparateThread)
```
    Constructs a new ScheduledJobImpl
    
    Parameters:
    pJobName - the name of the job;
    pJobDescription - the description of the job
    pSourceName - the name of the job's source
    pSchedule - the schedule for the job
    pSchedulable - the object to be notified when the job occurs
    pSeparateThread - if true, then the threadMethod is set to SEPARATE_THREAD, otherwise it is set to SCHEDULER_THREAD. This is here for backwards-compatibility before the threadMethod was available.
  - ScheduledJob
```
public ScheduledJob(java.lang.String pJobName,
            java.lang.String pJobDescription,
            java.lang.String pSourceName,
            Schedule pSchedule,
            Schedulable pSchedulable,
            int pThreadMethod)
```
    Constructs a new ScheduledJobImpl
    
    Parameters:
    pJobName - the name of the job;
    pJobDescription - the description of the job
    pSourceName - the name of the job's source
    pSchedule - the schedule for the job
    pSchedulable - the object to be notified when the job occurs
    pThreadMethod - the threading method to be used for the job. Should be one of SCHEDULER_THREAD, SEPARATE_THREAD, or REUSED_THREAD.
  - ScheduledJob
```
public ScheduledJob(java.lang.String pJobName,
            java.lang.String pJobDescription,
            java.lang.String pSourceName,
            Schedule pSchedule,
            Schedulable pSchedulable,
            int pThreadMethod,
            boolean pTransactional)
```
    Constructs a new ScheduledJobImpl
    
    Parameters:
    pJobName - the name of the job;
    pJobDescription - the description of the job
    pSourceName - the name of the job's source
    pSchedule - the schedule for the job
    pSchedulable - the object to be notified when the job occurs
    pThreadMethod - the threading method to be used for the job. Should be one of SCHEDULER_THREAD, SEPARATE_THREAD, or REUSED_THREAD.
    pTransactional - flag indicating if each occurrence of this job should execute in its own transaction
- Method Detail
  - getJobId
```
public int getJobId()
```
    Returns the id of the job
  - setJobId
```
public void setJobId(int pJobId)
```
    Sets the id of the job. This should only be called by the Scheduler.
  - getJobName
```
public java.lang.String getJobName()
```
    Returns the name of the job
  - getJobDescription
```
public java.lang.String getJobDescription()
```
    Returns the description of the job
  - getSourceName
```
public java.lang.String getSourceName()
```
    Returns the source name of the job
  - getSchedule
```
public Schedule getSchedule()
```
    Returns the Schedule for this job
  - getSchedulable
```
public Schedulable getSchedulable()
```
    Returns the Schedulable object that will be notified of this job.
  - getThreadMethod
```
public int getThreadMethod()
```
    Returns the threading method used for the job. Should be one of SCHEDULER_THREAD, SEPARATE_THREAD, REUSED_THREAD.
  - getTransactional
```
public boolean getTransactional()
```
    Returns the flag indicating if the job should be running in its own transaction context.
  - getLastJobTime
```
public long getLastJobTime()
```
    Returns the last time the job was run, or 0 if the job has not yet been run.
  - getNextJobTime
```
public long getNextJobTime()
```
    Return the next job time, calculated from the last job time. If no schedule has been set, then an NPE will occur.
  - getRunCount
```
public int getRunCount()
```
    Returns the number of times the job has been run
  - getStringForThreadMethod
```
public static java.lang.String getStringForThreadMethod(int pThreadMethod)
```
    Return the string that corresponds to pThreadMethod.
    
    Parameters:
    pThreadMethod - the thread method whose string to return.
    
    Returns:
    the String that corresponds to pThreadMethod.
    
    Throws:
    
    java.lang.IllegalArgumentException - if pThreadMethod does not correspond to a known thread method.
  - getThreadMethodForString
```
public static int getThreadMethodForString(java.lang.String pThreadMethod)
```
    Return the thread method integer that corresponds to the pThreadMethod string.
    
    Parameters:
    pThreadMethod - the thread string whose corresponding integer value to return.
    
    Returns:
    the integer that corresponds to pThreadMethod.
    
    Throws:
    
    java.lang.IllegalArgumentException - if pThreadMethod does not correspond to a known thread method.

Class ScheduledJob

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

SCHEDULER_THREAD

SEPARATE_THREAD

REUSED_THREAD

SCHEDULER_THREAD_STRING

SEPARATE_THREAD_STRING

REUSED_THREAD_STRING

Constructor Detail

ScheduledJob

ScheduledJob

ScheduledJob

Method Detail

getJobId

setJobId

getJobName

getJobDescription

getSourceName

getSchedule

getSchedulable

getThreadMethod

getTransactional

getLastJobTime

getNextJobTime

getRunCount

getStringForThreadMethod

getThreadMethodForString