PTP
Release 5.0

org.eclipse.ptp.ui
Interface IJobManager

All Superinterfaces:
IElementManager
All Known Implementing Classes:
JobManager, UIDebugManager

public interface IJobManager
extends IElementManager


Field Summary
 
Fields inherited from interface org.eclipse.ptp.ui.IElementManager
ADD_ELEMENT_TYPE, CHANGE_SET_TYPE, CREATE_SET_TYPE, DELETE_SET_TYPE, EMPTY_ID, REMOVE_ELEMENT_TYPE
 
Method Summary
 void addJobChangedListener(IJobChangedListener jobListener)
          Add job listener
 void addProcess(org.eclipse.ptp.core.elements.IPJob job, int procJobRank)
          Add a process to the view.
 IElementHandler createElementHandler(org.eclipse.ptp.core.elements.IPJob job)
          Create an element handler for the job
 org.eclipse.ptp.core.elements.IPJob findJobById(String jobId)
          Find a job give its ID.
 void fireJobChangedEvent(int type, String cur_jid, String pre_jid)
          Fire job event when job is changed
 org.eclipse.ptp.core.elements.IPJob getJob()
          Get the currently selected job.
 org.eclipse.ptp.core.elements.IPJob[] getJobs()
          Get Jobs that we know about.
 org.eclipse.ptp.core.elements.IPQueue getQueue()
          Get the currently selected queue.
 boolean hasStoppedJob()
          Test if there is at least one completed job.
 void removeAllStoppedJobs()
          Remove all jobs that have completed from the view
 void removeJob(org.eclipse.ptp.core.elements.IPJob job)
          Remove job from view.
 void removeJobChangedListener(IJobChangedListener jobListener)
          Remove job listener
 void removeProcess(org.eclipse.ptp.core.elements.IPJob job, int procJobRank)
          Remove a process from the view.
 void setJob(org.eclipse.ptp.core.elements.IPJob job)
          Set the current job
 void terminateJob()
          Terminate the currently selected job.
 
Methods inherited from interface org.eclipse.ptp.ui.IElementManager
addSetListener, addToSet, addToSet, clear, createSet, fireSetEvent, getCurrentSetId, getElementHandler, getFullyQualifiedName, getImage, getName, initial, removeElementHandler, removeFromSet, removeSet, removeSetListener, setCurrentSetId, setElementHandler, shutdown, size
 

Method Detail

addJobChangedListener

void addJobChangedListener(IJobChangedListener jobListener)
Add job listener

Parameters:
jobListener -

addProcess

void addProcess(org.eclipse.ptp.core.elements.IPJob job,
                int procJobRank)
Add a process to the view.

Parameters:
job -
procJobRank -
Since:
4.0

createElementHandler

IElementHandler createElementHandler(org.eclipse.ptp.core.elements.IPJob job)
Create an element handler for the job

Parameters:
job - job
Returns:
element handler for the job

findJobById

org.eclipse.ptp.core.elements.IPJob findJobById(String jobId)
Find a job give its ID.

Parameters:
jobId - ID of job to find
Returns:
job with corresponding ID

fireJobChangedEvent

void fireJobChangedEvent(int type,
                         String cur_jid,
                         String pre_jid)
Fire job event when job is changed

Parameters:
type - job change type or remove type
cur_jid -
pre_jid -

getJob

org.eclipse.ptp.core.elements.IPJob getJob()
Get the currently selected job.

Returns:
currently selected job

getJobs

org.eclipse.ptp.core.elements.IPJob[] getJobs()
Get Jobs that we know about.

Returns:
jobs

getQueue

org.eclipse.ptp.core.elements.IPQueue getQueue()
Get the currently selected queue.

Returns:
currently selected queue

hasStoppedJob

boolean hasStoppedJob()
Test if there is at least one completed job.

Returns:
true if there is a completed job

removeAllStoppedJobs

void removeAllStoppedJobs()
Remove all jobs that have completed from the view


removeJob

void removeJob(org.eclipse.ptp.core.elements.IPJob job)
Remove job from view.

Parameters:
job -

removeJobChangedListener

void removeJobChangedListener(IJobChangedListener jobListener)
Remove job listener

Parameters:
jobListener -

removeProcess

void removeProcess(org.eclipse.ptp.core.elements.IPJob job,
                   int procJobRank)
Remove a process from the view.

Parameters:
job -
procJobRank -
Since:
4.0

setJob

void setJob(org.eclipse.ptp.core.elements.IPJob job)
Set the current job

Parameters:
job - the current job to set

terminateJob

void terminateJob()
                  throws org.eclipse.core.runtime.CoreException
Terminate the currently selected job.

Throws:
org.eclipse.core.runtime.CoreException

PTP
Release 5.0

Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.