Class JDPJob

java.lang.Object
   |
   +----JDPJob

public class JDPJob
extends Object
Class JDPJob represents a Job.


Variable Index

 o ACTIVE
Job Active Status.
 o ACTIVEHELD
Job Active and Held Status.
 o COMPLETE
Job Complete Status.
 o CREATED
Job Created Status.
 o INCOMPLETE
Job InComplete Status.
 o QUEUED
Job Queued Status.
 o QUEUEDHELD
Job Queued and Held Status.

Constructor Index

 o JDPJob(JDPSubsystemMgr, String)
Creates a Job with the specified name.
 o JDPJob(JDPSubsystemMgr, String, int)
Creates a Job with the specified name.

Method Index

 o appendJobLog(String)
Append to the job log for this Job.
 o getActiveJob()
Get the handle to the active job of this Job.
 o getEndDate()
Get the date this job ended.
 o getEndTime()
Get the time this job ended.
 o getEventType()
Get the event type for this Job.
 o getInstance()
Get the handle to the actual class that is running inside of this job.
 o getJDPSystem()
Get the system number of this Job.
 o getJobChanged()
Get whether any aspect of this job has changed.
 o getJobLog()
Get the job log for this Job.
 o getJobLogBuffer()
Get the handle to the job log for this Job.
 o getJobName()
Get the name of this Job.
 o getJobNumber()
Get the number of this Job.
 o getJobOwner()
Get the owner of this Job.
 o getJobPriority()
Get the priority of this Job.
 o getJobQueue()
Get the job queue for this Job.
 o getJobQueuePriority()
Get the priority of this Job on the Job Queue.
 o getJobStatus()
Get the status of this Job.
 o getLogEvent()
Get the logging setting for this Job.
 o getLogEventNow()
Get whether this event should be logged.
 o getNotifyNow()
Get whether the person responsible for this event should be notified.
 o getNotifyOn()
Get the completion status to notify upon completion of this Job.
 o getNotifyUser()
Get the user to notify upon completion of this Job.
 o getNotifyVia()
Get the media to use to notify upon completion of this Job.
 o getObject()
Get the object for this Job.
 o getObjectConstructor()
Get the object constructor for this Job.
 o getObjectParm()
Get the object parameters for this Job.
 o getObjectType()
Get the object type for this Job.
 o getQueuedDate()
Get the date this job was queued.
 o getQueuedTime()
Get the time this job was queued.
 o getStartDate()
Get the date this job started.
 o getStartTime()
Get the time this job started.
 o getSubsystem()
Get the subsystem that this job ran in.
 o logException(Exception)
Log an exception to the Job Log.
 o setActiveJob(JDPActiveJob)
Set the handle to the active job of this Job.
 o setEndDate(Date)
Set the date this job ended.
 o setEndTime(long)
Set the time this job ended.
 o setEventType(String)
Set the event type for this Job.
 o setInstance(Object)
Set the handle to the actual class that is running inside of this job.
 o setJDPSystem(String)
Set the system number of this Job.
 o setJobName(String)
Set the name of this Job.
 o setJobOwner(String)
Set the owner of this Job.
 o setJobPriority(int)
Set the priority of this Job.
 o setJobQueue(String)
Set the job queue for this Job.
 o setJobQueuePriority(int)
Set the priority of this Job on the Job Queue.
 o setLogEvent(String)
Set the logging setting for this Job.
 o setLogEventNow(boolean)
Tell the subsystem manager to log this event.
 o setNotifyNow(boolean)
Tell the subsystem manager to notify of the completion of this event.
 o setNotifyOn(String)
Set the completion status to notify upon completion of this Job.
 o setNotifyUser(int)
Set the user to notify upon completion of this Job.
 o setNotifyVia(String)
Set the media to use to notify upon completion of this Job.
 o setObject(String)
Set the object for this Job.
 o setObjectConstructor(String)
Set the object constructor for this Job.
 o setObjectParm(String)
Set the object parameters for this Job.
 o setObjectType(String)
Set the object type for this Job.
 o setQueuedDate(Date)
Set the date this job was queued.
 o setQueuedTime(long)
Set the time this job was queued.
 o setStartDate(Date)
Set the date this job started.
 o setStartTime(long)
Set the time this job started.
 o setSubsystem(String)
Set the subsystem that this job is running in.

Variables

 o CREATED
 public static final int CREATED
Job Created Status.

 o QUEUED
 public static final int QUEUED
Job Queued Status.

 o QUEUEDHELD
 public static final int QUEUEDHELD
Job Queued and Held Status.

 o ACTIVE
 public static final int ACTIVE
Job Active Status.

 o ACTIVEHELD
 public static final int ACTIVEHELD
Job Active and Held Status.

 o INCOMPLETE
 public static final int INCOMPLETE
Job InComplete Status. Occurs if Job did not run to completion for any reason.

 o COMPLETE
 public static final int COMPLETE
Job Complete Status.

Constructors

 o JDPJob
 public JDPJob(JDPSubsystemMgr manager,
               String jobName)
Creates a Job with the specified name.

Parameters:
jobName - the name of the Job.
 o JDPJob
 public JDPJob(JDPSubsystemMgr manager,
               String jobName,
               int jobNumber)
Creates a Job with the specified name.

Parameters:
jobName - the name of the Job.
jobNumber - the number of the Job.

Methods

 o getActiveJob
 public JDPActiveJob getActiveJob()
Get the handle to the active job of this Job.

Returns:
the handle to the active job of this Job.
 o setActiveJob
 public void setActiveJob(JDPActiveJob job)
Set the handle to the active job of this Job.

Parameters:
job - the handle to the active job of this Job.
 o setInstance
 public void setInstance(Object thisObject)
Set the handle to the actual class that is running inside of this job.

Parameters:
thisObject - the handle to the the actual class that is running.
 o getInstance
 public Object getInstance()
Get the handle to the actual class that is running inside of this job.

Returns:
the handle to the the actual class that is running.
 o getJobName
 public String getJobName()
Get the name of this Job.

Returns:
the name of this Job.
 o setJobName
 public void setJobName(String jobName)
Set the name of this Job.

Parameters:
JobName - the name of this Job.
 o getJDPSystem
 public String getJDPSystem()
Get the system number of this Job.

Returns:
the system number of this Job.
 o setJDPSystem
 public void setJDPSystem(String JDPSystem)
Set the system number of this Job.

Parameters:
JDPSystem - the system number of this Job.
 o getJobNumber
 public int getJobNumber()
Get the number of this Job.

Returns:
the number of this Job.
 o getJobOwner
 public String getJobOwner()
Get the owner of this Job.

Returns:
the owner of this Job.
 o setJobOwner
 public void setJobOwner(String jobOwner)
Set the owner of this Job.

Parameters:
jobOwner - the owner of this Job.
 o getJobQueue
 public String getJobQueue()
Get the job queue for this Job.

Returns:
the job queue for this Job.
 o setJobQueue
 public void setJobQueue(String jobQueue)
Set the job queue for this Job.

Parameters:
jobQueue - the job queue for this Job.
 o getSubsystem
 public String getSubsystem()
Get the subsystem that this job ran in.

Returns:
the subsystem that this job ran in.
 o setSubsystem
 public void setSubsystem(String subsystem)
Set the subsystem that this job is running in.

Parameters:
subsystem - the subsystem that this job is running in.
 o getJobLog
 public String getJobLog()
Get the job log for this Job.

Returns:
the job log for this Job.
 o getJobLogBuffer
 public StringBuffer getJobLogBuffer()
Get the handle to the job log for this Job.

Returns:
the handle to the job log for this Job.
 o appendJobLog
 public void appendJobLog(String log)
Append to the job log for this Job.

Parameters:
log - the string to append to the job log for this Job.
 o logException
 public void logException(Exception e)
Log an exception to the Job Log.

Parameters:
e - the exception that was thrown by the job.
 o getJobPriority
 public int getJobPriority()
Get the priority of this Job.

Returns:
the priority of this Job.
 o setJobPriority
 public void setJobPriority(int priority)
Set the priority of this Job.

Parameters:
priority - the priority of this Job.
 o getJobQueuePriority
 public int getJobQueuePriority()
Get the priority of this Job on the Job Queue.

Returns:
the priority of this Job on the Job Queue.
 o setJobQueuePriority
 public void setJobQueuePriority(int priority)
Set the priority of this Job on the Job Queue.

Parameters:
priority - the priority of this Job on the Job Queue.
 o getEventType
 public String getEventType()
Get the event type for this Job.

Returns:
the event type for this Job.
 o setEventType
 public void setEventType(String eventType)
Set the event type for this Job.

Parameters:
eventType - the event type for this Job.
 o getObjectType
 public String getObjectType()
Get the object type for this Job.

Returns:
the object type for this Job.
 o setObjectType
 public void setObjectType(String objectType)
Set the object type for this Job.

Parameters:
objectType - the object type for this Job.
 o getObject
 public String getObject()
Get the object for this Job.

Returns:
the object for this Job.
 o setObject
 public void setObject(String object)
Set the object for this Job.

Parameters:
object - the object for this Job.
 o getObjectParm
 public String getObjectParm()
Get the object parameters for this Job.

Returns:
the object parameters for this Job.
 o setObjectParm
 public void setObjectParm(String objectParm)
Set the object parameters for this Job.

Parameters:
objectParm - the object parameters for this Job.
 o getObjectConstructor
 public String getObjectConstructor()
Get the object constructor for this Job.

Returns:
the object constructor for this Job.
 o setObjectConstructor
 public void setObjectConstructor(String objectConstructor)
Set the object constructor for this Job.

Parameters:
objectConstructor - the object constructor for this Job.
 o getNotifyUser
 public int getNotifyUser()
Get the user to notify upon completion of this Job.

Returns:
the user to notify upon completion of this Job.
 o setNotifyUser
 public void setNotifyUser(int user)
Set the user to notify upon completion of this Job.

Parameters:
user - the user to notify upon completion of this Job.
 o getNotifyVia
 public String getNotifyVia()
Get the media to use to notify upon completion of this Job.

Returns:
the media to use to notify upon completion of this Job.
 o setNotifyVia
 public void setNotifyVia(String via)
Set the media to use to notify upon completion of this Job.

Parameters:
via - the media to use to notify upon completion of this Job.
 o getNotifyOn
 public String getNotifyOn()
Get the completion status to notify upon completion of this Job.

Returns:
the completion status to notify upon completion of this Job.
 o setNotifyOn
 public void setNotifyOn(String on)
Set the completion status to notify upon completion of this Job.

Parameters:
On - the completion status to notify upon completion of this Job.
 o getNotifyNow
 public boolean getNotifyNow()
Get whether the person responsible for this event should be notified.

Returns:
whether the person responsible for this this event should be notified.
 o setNotifyNow
 public void setNotifyNow(boolean notifyNow)
Tell the subsystem manager to notify of the completion of this event.

Parameters:
notifyNow - whether the subsystem manager should notify of the completion of this event.
 o getLogEvent
 public String getLogEvent()
Get the logging setting for this Job.

Returns:
the logging setting for this Job.
 o setLogEvent
 public void setLogEvent(String logEvent)
Set the logging setting for this Job.

Parameters:
logEvent - the logging setting for this Job.
 o getLogEventNow
 public boolean getLogEventNow()
Get whether this event should be logged.

Returns:
whether this event should be logged.
 o setLogEventNow
 public void setLogEventNow(boolean logEventNow)
Tell the subsystem manager to log this event.

Parameters:
logEventNow - whether the subsystem manager should log this event.
 o getQueuedDate
 public Date getQueuedDate()
Get the date this job was queued.

Returns:
the date this job was queued.
 o setQueuedDate
 public void setQueuedDate(Date queuedDate)
Set the date this job was queued.

Parameters:
queuedDate - the date this job was queued.
 o getQueuedTime
 public long getQueuedTime()
Get the time this job was queued.

Returns:
the time this job was queued.
 o setQueuedTime
 public void setQueuedTime(long queuedTime)
Set the time this job was queued.

Parameters:
queuedTime - the time this job was queued.
 o getStartDate
 public Date getStartDate()
Get the date this job started.

Returns:
the date this job started.
 o setStartDate
 public void setStartDate(Date startDate)
Set the date this job started.

Parameters:
startDate - the date this job started.
 o getStartTime
 public long getStartTime()
Get the time this job started.

Returns:
the time this job started.
 o setStartTime
 public void setStartTime(long startTime)
Set the time this job started.

Parameters:
startTime - the time this job started.
 o getEndDate
 public Date getEndDate()
Get the date this job ended.

Returns:
the date this job ended.
 o setEndDate
 public void setEndDate(Date endDate)
Set the date this job ended.

Parameters:
endDate - the date this job ended.
 o getEndTime
 public long getEndTime()
Get the time this job ended.

Returns:
the time this job ended.
 o setEndTime
 public void setEndTime(long endTime)
Set the time this job ended.

Parameters:
endTime - the time this job ended.
 o getJobChanged
 public boolean getJobChanged()
Get whether any aspect of this job has changed.

Returns:
whether any aspect of this job has changed.
 o getJobStatus
 public int getJobStatus()
Get the status of this Job.

Returns:
the status of this Job.