com.ibm.etools.iseries.remotebuild
Class RBJobTicketSource

java.lang.Object
  com.ibm.etools.iseries.remotebuild.RBJobTicketSource

All Implemented Interfaces:

IJobTicketSource

public class RBJobTicketSource
extends Object
implements IJobTicketSource

This class is used to when adding JobTickets for Remote builds to the JobTicketManager. It allows the remote build to add popup menus to the build jobs and to notify the remote build when a job completes.

Field Summary

protected Action	cancelAction
static String	Copyright
protected RBProject	project
protected Action	retrieveErrorsAction
protected String	tag

Constructor Summary

RBJobTicketSource(RBProject project, String tag)
Constructor

Method Summary

void	cancel(JobTicket ticket) Cancels a job represented by the job ticket.
boolean	canRemove(JobTicket jobTicket) Allows job ticket sources to prevent a job from being removed from the job status view when the user attempts to remove the job or remove all jobs from the view.
protected IViewPart	getJobMonitorView() Helper method for retrieving the Job Monitor View if it is showing, or null if it is not showing.
IJobTicketSourceFactory	getJobTicketSourceFactory() Return the IJobTicketSourceFactory used for persisting and restoring this job ticket source from a memento.
RBProject	getProject() Returns the project of the job.
String	getTag() Returns the tag for the job.
void	jobRemoved(JobTicket jobTicket) Notification that the job was removed from the Job status view.
void	populateTaskMenu(MenuManager menu, JobTicket jobTicket) Allow ticket source's to populate the "Task Actions" section of the pop-up menu for jobs in the Status view.
protected RBStatus	readStreamFile(AS400 system, String remoteFileName, String localFileName) Reads a text stream file from a remote system into the workspace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

project

protected RBProject project

tag

protected String tag

retrieveErrorsAction

protected Action retrieveErrorsAction

cancelAction

protected Action cancelAction

Constructor Detail

RBJobTicketSource

public RBJobTicketSource(RBProject project,
                         String tag)

Constructor

Parameters:

project - The iSeries project for this remote build

tag - the tag used for this job submission

Method Detail

getProject

public RBProject getProject()

Returns the project of the job.

getTag

public String getTag()

Returns the tag for the job.

populateTaskMenu

public void populateTaskMenu(MenuManager menu,
                             JobTicket jobTicket)

Description copied from interface: IJobTicketSource

Allow ticket source's to populate the "Task Actions" section of the pop-up menu for jobs in the Status view.

Specified by:

populateTaskMenu in interface IJobTicketSource

canRemove

public boolean canRemove(JobTicket jobTicket)

Description copied from interface: IJobTicketSource

Allows job ticket sources to prevent a job from being removed from the job status view when the user attempts to remove the job or remove all jobs from the view.

Specified by:

canRemove in interface IJobTicketSource

jobRemoved

public void jobRemoved(JobTicket jobTicket)

Description copied from interface: IJobTicketSource

Notification that the job was removed from the Job status view. This allows the job ticket source to perform any cleanup required.

Specified by:

jobRemoved in interface IJobTicketSource

readStreamFile

protected RBStatus readStreamFile(AS400 system,
                                  String remoteFileName,
                                  String localFileName)

Reads a text stream file from a remote system into the workspace.

cancel

public void cancel(JobTicket ticket)

Cancels a job represented by the job ticket. This will only cancel the job if the ticket returns a non-null connection. If the ticket is not managed by this manager it does nothing.

Used to implement a "cancel" or "endjob" function by the user interface.

getJobMonitorView

protected IViewPart getJobMonitorView()

Helper method for retrieving the Job Monitor View if it is showing, or null if it is not showing.

getJobTicketSourceFactory

public IJobTicketSourceFactory getJobTicketSourceFactory()

Description copied from interface: IJobTicketSource

Return the IJobTicketSourceFactory used for persisting and restoring this job ticket source from a memento. Return null if no factory is provided. In this case the job will still be persisted but all task specific properites and actions will be lost.

Specified by:

getJobTicketSourceFactory in interface IJobTicketSource