Class JDPJob

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

public class JDPJob

extends Object

ACTIVE

Job Active Status.

ACTIVEHELD

Job Active and Held Status.

COMPLETE

Job Complete Status.

CREATED

Job Created Status.

INCOMPLETE

Job InComplete Status.

QUEUED

Job Queued Status.

QUEUEDHELD

Job Queued and Held Status.

JDPJob(JDPSubsystemMgr, String)

Creates a Job with the specified name.

JDPJob(JDPSubsystemMgr, String, int)

Creates a Job with the specified name.

appendJobLog(String)

Append to the job log for this Job.

getActiveJob()

Get the handle to the active job of this Job.

getEndDate()

Get the date this job ended.

getEndTime()

Get the time this job ended.

getEventType()

Get the event type for this Job.

getInstance()

Get the handle to the actual class that is running inside of this job.

getJDPSystem()

Get the system number of this Job.

getJobChanged()

Get whether any aspect of this job has changed.

getJobLog()

Get the job log for this Job.

getJobLogBuffer()

Get the handle to the job log for this Job.

getJobName()

Get the name of this Job.

getJobNumber()

Get the number of this Job.

getJobOwner()

Get the owner of this Job.

getJobPriority()

Get the priority of this Job.

getJobQueue()

Get the job queue for this Job.

getJobQueuePriority()

Get the priority of this Job on the Job Queue.

getJobStatus()

Get the status of this Job.

getLogEvent()

Get the logging setting for this Job.

getLogEventNow()

Get whether this event should be logged.

getNotifyNow()

Get whether the person responsible for this event should be notified.

getNotifyOn()

Get the completion status to notify upon completion of this Job.

getNotifyUser()

Get the user to notify upon completion of this Job.

getNotifyVia()

Get the media to use to notify upon completion of this Job.

getObject()

Get the object for this Job.

getObjectConstructor()

Get the object constructor for this Job.

getObjectParm()

Get the object parameters for this Job.

getObjectType()

Get the object type for this Job.

getQueuedDate()

Get the date this job was queued.

getQueuedTime()

Get the time this job was queued.

getSkipJobLog()

Get whether the subsystem manager will skip writing the actual text job log of this job as it contains invalid characters that wont go into the database.

getStartDate()

Get the date this job started.

getStartTime()

Get the time this job started.

getSubsystem()

Get the subsystem that this job ran in.

logException(Exception)

Log an exception to the Job Log.

setActiveJob(JDPActiveJob)

Set the handle to the active job of this Job.

setEndDate(Date)

Set the date this job ended.

setEndTime(long)

Set the time this job ended.

setEventType(String)

Set the event type for this Job.

setInstance(Object)

Set the handle to the actual class that is running inside of this job.

setJDPSystem(String)

Set the system number of this Job.

setJobName(String)

Set the name of this Job.

setJobOwner(String)

Set the owner of this Job.

setJobPriority(int)

Set the priority of this Job.

setJobQueue(String)

Set the job queue for this Job.

setJobQueuePriority(int)

Set the priority of this Job on the Job Queue.

setLogEvent(String)

Set the logging setting for this Job.

setLogEventNow(boolean)

Tell the subsystem manager to log this event.

setNotifyNow(boolean)

Tell the subsystem manager to notify of the completion of this event.

setNotifyOn(String)

Set the completion status to notify upon completion of this Job.

setNotifyUser(int)

Set the user to notify upon completion of this Job.

setNotifyVia(String)

Set the media to use to notify upon completion of this Job.

setObject(String)

Set the object for this Job.

setObjectConstructor(String)

Set the object constructor for this Job.

setObjectParm(String)

Set the object parameters for this Job.

setObjectType(String)

Set the object type for this Job.

setQueuedDate(Date)

Set the date this job was queued.

setQueuedTime(long)

Set the time this job was queued.

setSkipJobLog(boolean)

Tell the subsystem manager to skip writing the actual text job log of this job as it contains invalid characters that wont go into the database.

setStartDate(Date)

Set the date this job started.

setStartTime(long)

Set the time this job started.

setSubsystem(String)

Set the subsystem that this job is running in.

 public static final int CREATED

Job Created Status.

 public static final int QUEUED

Job Queued Status.

 public static final int QUEUEDHELD

Job Queued and Held Status.

 public static final int ACTIVE

Job Active Status.

 public static final int ACTIVEHELD

Job Active and Held Status.

 public static final int INCOMPLETE

Job InComplete Status. Occurs if Job did not run to completion for any reason.

 public static final int COMPLETE

Job Complete Status.

 public JDPJob(JDPSubsystemMgr manager,
               String jobName)

Creates a Job with the specified name.

Parameters:

jobName - the name of the Job.

 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.

 public JDPActiveJob getActiveJob()

Get the handle to the active job of this Job.

Returns:

the handle to the active job of this Job.

 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.

 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.

 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.

 public String getJobName()

Get the name of this Job.

Returns:

the name of this Job.

 public void setJobName(String jobName)

Set the name of this Job.

Parameters:

JobName - the name of this Job.

 public String getJDPSystem()

Get the system number of this Job.

Returns:

the system number of this Job.

 public void setJDPSystem(String JDPSystem)

Set the system number of this Job.

Parameters:

JDPSystem - the system number of this Job.

 public int getJobNumber()

Get the number of this Job.

Returns:

the number of this Job.

 public String getJobOwner()

Get the owner of this Job.

Returns:

the owner of this Job.

 public void setJobOwner(String jobOwner)

Set the owner of this Job.

Parameters:

jobOwner - the owner of this Job.

 public String getJobQueue()

Get the job queue for this Job.

Returns:

the job queue for this Job.

 public void setJobQueue(String jobQueue)

Set the job queue for this Job.

Parameters:

jobQueue - the job queue for this Job.

 public String getSubsystem()

Get the subsystem that this job ran in.

Returns:

the subsystem that this job ran in.

 public void setSubsystem(String subsystem)

Set the subsystem that this job is running in.

Parameters:

subsystem - the subsystem that this job is running in.

 public String getJobLog()

Get the job log for this Job.

Returns:

the job log for this Job.

 public StringBuffer getJobLogBuffer()

Get the handle to the job log for this Job.

Returns:

the handle to the job log for this Job.

 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.

 public void logException(Exception e)

Log an exception to the Job Log.

Parameters:

e - the exception that was thrown by the job.

 public int getJobPriority()

Get the priority of this Job.

Returns:

the priority of this Job.

 public void setJobPriority(int priority)

Set the priority of this Job.

Parameters:

priority - the priority of this Job.

 public int getJobQueuePriority()

Get the priority of this Job on the Job Queue.

Returns:

the priority of this Job on the Job Queue.

 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.

 public String getEventType()

Get the event type for this Job.

Returns:

the event type for this Job.

 public void setEventType(String eventType)

Set the event type for this Job.

Parameters:

eventType - the event type for this Job.

 public String getObjectType()

Get the object type for this Job.

Returns:

the object type for this Job.

 public void setObjectType(String objectType)

Set the object type for this Job.

Parameters:

objectType - the object type for this Job.

 public String getObject()

Get the object for this Job.

Returns:

the object for this Job.

 public void setObject(String object)

Set the object for this Job.

Parameters:

object - the object for this Job.

 public String getObjectParm()

Get the object parameters for this Job.

Returns:

the object parameters for this Job.

 public void setObjectParm(String objectParm)

Set the object parameters for this Job.

Parameters:

objectParm - the object parameters for this Job.

 public String getObjectConstructor()

Get the object constructor for this Job.

Returns:

the object constructor for this Job.

 public void setObjectConstructor(String objectConstructor)

Set the object constructor for this Job.

Parameters:

objectConstructor - the object constructor for this Job.

 public int getNotifyUser()

Get the user to notify upon completion of this Job.

Returns:

the user to notify upon completion of this Job.

 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.

 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.

 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.

 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.

 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.

 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.

 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.

 public String getLogEvent()

Get the logging setting for this Job.

Returns:

the logging setting for this Job.

 public void setLogEvent(String logEvent)

Set the logging setting for this Job.

Parameters:

logEvent - the logging setting for this Job.

 public boolean getLogEventNow()

Get whether this event should be logged.

Returns:

whether this event should be logged.

 public void setSkipJobLog(boolean skip)

Tell the subsystem manager to skip writing the actual text job log of this job as it contains invalid characters that wont go into the database.

Parameters:

skip - whether the subsystem manager should write job log text.

 public boolean getSkipJobLog()

Get whether the subsystem manager will skip writing the actual text job log of this job as it contains invalid characters that wont go into the database.

Parameters:

skip - whether the subsystem manager should write job log text.

 public void setLogEventNow(boolean logEventNow)

Tell the subsystem manager to log this event.

Parameters:

logEventNow - whether the subsystem manager should log this event.

 public Date getQueuedDate()

Get the date this job was queued.

Returns:

the date this job was queued.

 public void setQueuedDate(Date queuedDate)

Set the date this job was queued.

Parameters:

queuedDate - the date this job was queued.

 public long getQueuedTime()

Get the time this job was queued.

Returns:

the time this job was queued.

 public void setQueuedTime(long queuedTime)

Set the time this job was queued.

Parameters:

queuedTime - the time this job was queued.

 public Date getStartDate()

Get the date this job started.

Returns:

the date this job started.

 public void setStartDate(Date startDate)

Set the date this job started.

Parameters:

startDate - the date this job started.

 public long getStartTime()

Get the time this job started.

Returns:

the time this job started.

 public void setStartTime(long startTime)

Set the time this job started.

Parameters:

startTime - the time this job started.

 public Date getEndDate()

Get the date this job ended.

Returns:

the date this job ended.

 public void setEndDate(Date endDate)

Set the date this job ended.

Parameters:

endDate - the date this job ended.

 public long getEndTime()

Get the time this job ended.

Returns:

the time this job ended.

 public void setEndTime(long endTime)

Set the time this job ended.

Parameters:

endTime - the time this job ended.

 public boolean getJobChanged()

Get whether any aspect of this job has changed.

Returns:

whether any aspect of this job has changed.

 public int getJobStatus()

Get the status of this Job.

Returns:

the status of this Job.