|
iSeries Remote Systems v6.0.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.iseries.core.jobs.JobTicket
A JobTicket stores information about a job running on an iSeries system. It can be saved and restored from a persistent form stored with the project metadata. Each ticket is persisted in a separate file. A project may have several tickets that each track a batch jobs for the project.
JobTickets are created by a user immediately after a job is submitted and then given to a JobTicketManager to manage. These are typically used to track build jobs.
Field Summary | |
---|---|
static String |
Copyright
|
protected static String |
JOBTICKET_DIRECTORY
|
static String |
TASK_BLANK
|
static String |
TASK_BUILD
|
static String |
TASK_COMPILE
|
Constructor Summary | |
---|---|
JobTicket(ISeriesConnection connection,
ISeriesJob job,
String task,
IJobTicketSource ticketSource)
Creates a new job ticket from its parameter parts. |
|
JobTicket(ISeriesConnection connection,
String jobNumber,
String jobUser,
String jobName,
String task,
IJobTicketSource ticketSource)
Creates a new job ticket from its parameter parts. |
|
JobTicket(com.ibm.etools.systems.subsystems.SubSystem jobSubSystem,
ISeriesJob job)
Creates a new job ticket from its parameter parts. |
|
JobTicket(com.ibm.etools.systems.subsystems.SubSystem jobSubSystem,
ISeriesJob job,
String task,
IJobTicketSource ticketSource)
Creates a new job ticket from its parameter parts. |
|
JobTicket(com.ibm.etools.systems.subsystems.SubSystem jobSubSystem,
String jobNumber,
String jobUser,
String jobName,
String task,
IJobTicketSource ticketSource)
Creates a new job ticket from its parameter parts. |
Method Summary | |
---|---|
protected void |
clearMemento()
Clear the memento for this job. |
static JobTicket |
createFrom(File mementoFile)
Loads a ticket for a project with a given name. |
boolean |
equals(Object object)
Override of equals to return true if two job tickets have the same job name, user and number and are from the same remote host. |
ISeriesConnection |
getConnection()
Returns an ISeriesConnection associated with this job. |
String |
getFileName()
Returns the simple filename under which this ticket will be stored. |
ISeriesJob |
getJob()
Return the ISeriesJob this ticket uses. |
String |
getJobName()
Returns the name of the job. |
String |
getJobNumber()
Returns the number of the job. |
IJobTicketSource |
getJobTicketSource()
Returns the job ticket source for this job. |
IPath |
getLocation()
Returns the location where this ticket is stored. |
IMemento |
getMemento()
Returns a memento for this ticket. |
String |
getQualifiedJobName()
Returns the fully qualified job name of this job ticket. |
String |
getStatusString()
Returns the status of the job. |
com.ibm.etools.systems.subsystems.SubSystem |
getSubSystem()
Returns the subsystem for the job. |
String |
getTask()
Returns the task for this Job. |
String |
getTicketName()
Returns the name of the job ticket. |
long |
getTimeStamp()
Returns the timeStamp of the job. |
String |
getUserName()
Returns the user under whose profile the job was submitted. |
boolean |
isDirty()
Returns true if and only if the ticket has been changed since it was last saved. |
boolean |
isFinished()
Check if this job is finished. |
boolean |
isJobQueued()
Check if this job is waiting on a job queue. |
boolean |
isOutputQueued()
Check if this job is waiting on an output queue. |
boolean |
isPersistJob()
Check if this job is persisted when the workbench is shutdown. |
boolean |
isRunning()
Check if this job is finished. |
void |
refresh()
Refresh the job information for this ticket |
void |
save()
Saves this ticket. |
void |
setJobTicketSource(IJobTicketSource ticketSource)
Sets the job ticket source for this job. |
void |
setPersistJob(boolean persist)
Set if this job is persisted when the workbench is shutdown. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String Copyright
public static final String TASK_BLANK
public static final String TASK_BUILD
public static final String TASK_COMPILE
protected static final String JOBTICKET_DIRECTORY
Constructor Detail |
public JobTicket(com.ibm.etools.systems.subsystems.SubSystem jobSubSystem, ISeriesJob job)
jobSubSystem
- the job subsystem with which this job is associated.job
- The ISeriesJob which represents this job on the iSeries.public JobTicket(ISeriesConnection connection, ISeriesJob job, String task, IJobTicketSource ticketSource)
connection
- The connection associated with the job.job
- The ISeriesJob which represents this job on the iSeries.task
- The task this job is assigned, this is just an arbittrary string to display in the table to
give the user some visual clue as to what this job is doingticketSource
- The source for this job ticket, used to get contributions for popup menu and notify source
of job status changes, can be nullpublic JobTicket(ISeriesConnection connection, String jobNumber, String jobUser, String jobName, String task, IJobTicketSource ticketSource)
connection
- The connection associated with the job.jobNumber
- The job numberjobUser
- The user name for the jobjobName
- The name of the jobtask
- The task this job is assigned, this is just an arbittrary string to display in the table to
give the user some visual clue as to what this job is doingticketSource
- The source for this job ticket, used to get contributions for popup menu and notify source
of job status changes, can be nullpublic JobTicket(com.ibm.etools.systems.subsystems.SubSystem jobSubSystem, ISeriesJob job, String task, IJobTicketSource ticketSource)
jobSubSystem
- the job subsystem with which this job is associated.job
- The ISeriesJob which represents this job on the iSeries.task
- The task this job is assigned, this is just an arbittrary string to display in the table to
give the user some visual clue as to what this job is doingticketSource
- The source for this job ticket, used to get contributions for popup menu and notify source
of job status changes, can be nullpublic JobTicket(com.ibm.etools.systems.subsystems.SubSystem jobSubSystem, String jobNumber, String jobUser, String jobName, String task, IJobTicketSource ticketSource)
jobSubSystem
- the job subsystem with which this job is associated.jobNumber
- The job numberjobUser
- The user name for the jobjobName
- The name of the jobtask
- The task this job is assigned, this is just an arbittrary string to display in the table to
give the user some visual clue as to what this job is doingticketSource
- The source for this job ticket, used to get contributions for popup menu and notify source
of job status changes, can be nullMethod Detail |
public static JobTicket createFrom(File mementoFile)
public void save()
public boolean isDirty()
public ISeriesConnection getConnection()
public long getTimeStamp()
public String getTicketName()
public ISeriesJob getJob()
public String getJobName()
public String getJobNumber()
public com.ibm.etools.systems.subsystems.SubSystem getSubSystem()
public String getStatusString()
public String getUserName()
public IMemento getMemento()
public String getQualifiedJobName()
public String getTask()
public IJobTicketSource getJobTicketSource()
public void setJobTicketSource(IJobTicketSource ticketSource)
public String getFileName()
public IPath getLocation()
public boolean isFinished()
public boolean isJobQueued()
public boolean isOutputQueued()
public boolean isRunning()
public void refresh()
public boolean equals(Object object)
Object.equals(java.lang.Object)
protected void clearMemento()
public boolean isPersistJob()
public void setPersistJob(boolean persist)
persist
- true if the job should be persisted.
|
iSeries Remote Systems v6.0.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |