Class JDPJob
java.lang.Object
|
+----JDPJob
- public class JDPJob
- extends Object
Class JDPJob represents a Job.
-
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.
-
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.
-
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.
CREATED
public static final int CREATED
- Job Created Status.
QUEUED
public static final int QUEUED
- Job Queued Status.
QUEUEDHELD
public static final int QUEUEDHELD
- Job Queued and Held Status.
ACTIVE
public static final int ACTIVE
- Job Active Status.
ACTIVEHELD
public static final int ACTIVEHELD
- Job Active and Held Status.
INCOMPLETE
public static final int INCOMPLETE
- Job InComplete Status. Occurs if Job did not run to completion for any reason.
COMPLETE
public static final int COMPLETE
- Job Complete Status.
JDPJob
public JDPJob(JDPSubsystemMgr manager,
String jobName)
- Creates a Job with the specified name.
- Parameters:
- jobName - the name of the Job.
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.
getActiveJob
public JDPActiveJob getActiveJob()
- Get the handle to the active job of this Job.
- Returns:
- the handle to the active job of this Job.
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.
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.
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.
getJobName
public String getJobName()
- Get the name of this Job.
- Returns:
- the name of this Job.
setJobName
public void setJobName(String jobName)
- Set the name of this Job.
- Parameters:
- JobName - the name of this Job.
getJDPSystem
public String getJDPSystem()
- Get the system number of this Job.
- Returns:
- the system number of this Job.
setJDPSystem
public void setJDPSystem(String JDPSystem)
- Set the system number of this Job.
- Parameters:
- JDPSystem - the system number of this Job.
getJobNumber
public int getJobNumber()
- Get the number of this Job.
- Returns:
- the number of this Job.
getJobOwner
public String getJobOwner()
- Get the owner of this Job.
- Returns:
- the owner of this Job.
setJobOwner
public void setJobOwner(String jobOwner)
- Set the owner of this Job.
- Parameters:
- jobOwner - the owner of this Job.
getJobQueue
public String getJobQueue()
- Get the job queue for this Job.
- Returns:
- the job queue for this Job.
setJobQueue
public void setJobQueue(String jobQueue)
- Set the job queue for this Job.
- Parameters:
- jobQueue - the job queue for this Job.
getSubsystem
public String getSubsystem()
- Get the subsystem that this job ran in.
- Returns:
- the subsystem that this job ran in.
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.
getJobLog
public String getJobLog()
- Get the job log for this Job.
- Returns:
- the job log for this Job.
getJobLogBuffer
public StringBuffer getJobLogBuffer()
- Get the handle to the job log for this Job.
- Returns:
- the handle to the job log for this Job.
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.
logException
public void logException(Exception e)
- Log an exception to the Job Log.
- Parameters:
- e - the exception that was thrown by the job.
getJobPriority
public int getJobPriority()
- Get the priority of this Job.
- Returns:
- the priority of this Job.
setJobPriority
public void setJobPriority(int priority)
- Set the priority of this Job.
- Parameters:
- priority - the priority of this Job.
getJobQueuePriority
public int getJobQueuePriority()
- Get the priority of this Job on the Job Queue.
- Returns:
- the priority of this Job on the Job Queue.
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.
getEventType
public String getEventType()
- Get the event type for this Job.
- Returns:
- the event type for this Job.
setEventType
public void setEventType(String eventType)
- Set the event type for this Job.
- Parameters:
- eventType - the event type for this Job.
getObjectType
public String getObjectType()
- Get the object type for this Job.
- Returns:
- the object type for this Job.
setObjectType
public void setObjectType(String objectType)
- Set the object type for this Job.
- Parameters:
- objectType - the object type for this Job.
getObject
public String getObject()
- Get the object for this Job.
- Returns:
- the object for this Job.
setObject
public void setObject(String object)
- Set the object for this Job.
- Parameters:
- object - the object for this Job.
getObjectParm
public String getObjectParm()
- Get the object parameters for this Job.
- Returns:
- the object parameters for this Job.
setObjectParm
public void setObjectParm(String objectParm)
- Set the object parameters for this Job.
- Parameters:
- objectParm - the object parameters for this Job.
getObjectConstructor
public String getObjectConstructor()
- Get the object constructor for this Job.
- Returns:
- the object constructor for this Job.
setObjectConstructor
public void setObjectConstructor(String objectConstructor)
- Set the object constructor for this Job.
- Parameters:
- objectConstructor - the object constructor for this Job.
getNotifyUser
public int getNotifyUser()
- Get the user to notify upon completion of this Job.
- Returns:
- the user to notify upon completion of this Job.
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.
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.
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.
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.
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.
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.
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.
getLogEvent
public String getLogEvent()
- Get the logging setting for this Job.
- Returns:
- the logging setting for this Job.
setLogEvent
public void setLogEvent(String logEvent)
- Set the logging setting for this Job.
- Parameters:
- logEvent - the logging setting for this Job.
getLogEventNow
public boolean getLogEventNow()
- Get whether this event should be logged.
- Returns:
- whether this event should be logged.
setLogEventNow
public void setLogEventNow(boolean logEventNow)
- Tell the subsystem manager to log this event.
- Parameters:
- logEventNow - whether the subsystem manager should log this event.
getQueuedDate
public Date getQueuedDate()
- Get the date this job was queued.
- Returns:
- the date this job was queued.
setQueuedDate
public void setQueuedDate(Date queuedDate)
- Set the date this job was queued.
- Parameters:
- queuedDate - the date this job was queued.
getQueuedTime
public long getQueuedTime()
- Get the time this job was queued.
- Returns:
- the time this job was queued.
setQueuedTime
public void setQueuedTime(long queuedTime)
- Set the time this job was queued.
- Parameters:
- queuedTime - the time this job was queued.
getStartDate
public Date getStartDate()
- Get the date this job started.
- Returns:
- the date this job started.
setStartDate
public void setStartDate(Date startDate)
- Set the date this job started.
- Parameters:
- startDate - the date this job started.
getStartTime
public long getStartTime()
- Get the time this job started.
- Returns:
- the time this job started.
setStartTime
public void setStartTime(long startTime)
- Set the time this job started.
- Parameters:
- startTime - the time this job started.
getEndDate
public Date getEndDate()
- Get the date this job ended.
- Returns:
- the date this job ended.
setEndDate
public void setEndDate(Date endDate)
- Set the date this job ended.
- Parameters:
- endDate - the date this job ended.
getEndTime
public long getEndTime()
- Get the time this job ended.
- Returns:
- the time this job ended.
setEndTime
public void setEndTime(long endTime)
- Set the time this job ended.
- Parameters:
- endTime - the time this job ended.
getJobChanged
public boolean getJobChanged()
- Get whether any aspect of this job has changed.
- Returns:
- whether any aspect of this job has changed.
getJobStatus
public int getJobStatus()
- Get the status of this Job.
- Returns:
- the status of this Job.