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.
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 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
|
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.
|
public static java.lang.String CLASS_VERSION
public static final int SCHEDULER_THREAD
public static final int SEPARATE_THREAD
public static final int REUSED_THREAD
public static final java.lang.String SCHEDULER_THREAD_STRING
public static final java.lang.String SEPARATE_THREAD_STRING
public static final java.lang.String REUSED_THREAD_STRING
public ScheduledJob(java.lang.String pJobName, java.lang.String pJobDescription, java.lang.String pSourceName, Schedule pSchedule, Schedulable pSchedulable, boolean pSeparateThread)
pJobName
- the name of the job;pJobDescription
- the description of the jobpSourceName
- the name of the job's sourcepSchedule
- the schedule for the jobpSchedulable
- the object to be notified when the job occurspSeparateThread
- 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.public ScheduledJob(java.lang.String pJobName, java.lang.String pJobDescription, java.lang.String pSourceName, Schedule pSchedule, Schedulable pSchedulable, int pThreadMethod)
pJobName
- the name of the job;pJobDescription
- the description of the jobpSourceName
- the name of the job's sourcepSchedule
- the schedule for the jobpSchedulable
- the object to be notified when the job occurspThreadMethod
- the threading method to be used for the job.
Should be one of SCHEDULER_THREAD, SEPARATE_THREAD, or
REUSED_THREAD.public ScheduledJob(java.lang.String pJobName, java.lang.String pJobDescription, java.lang.String pSourceName, Schedule pSchedule, Schedulable pSchedulable, int pThreadMethod, boolean pTransactional)
pJobName
- the name of the job;pJobDescription
- the description of the jobpSourceName
- the name of the job's sourcepSchedule
- the schedule for the jobpSchedulable
- the object to be notified when the job occurspThreadMethod
- 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 transactionpublic int getJobId()
public void setJobId(int pJobId)
public java.lang.String getJobName()
public java.lang.String getJobDescription()
public java.lang.String getSourceName()
public Schedule getSchedule()
public Schedulable getSchedulable()
public int getThreadMethod()
public boolean getTransactional()
public long getLastJobTime()
public long getNextJobTime()
public int getRunCount()
public static java.lang.String getStringForThreadMethod(int pThreadMethod)
pThreadMethod
- the thread method whose string to return.java.lang.IllegalArgumentException
- if pThreadMethod does not correspond
to a known thread method.public static int getThreadMethodForString(java.lang.String pThreadMethod)
pThreadMethod
- the thread string whose corresponding integer
value to return.java.lang.IllegalArgumentException
- if pThreadMethod does not correspond
to a known thread method.