com.ibm.carma.ui.job
Class OpenMemberJob

java.lang.Object
  extended by org.eclipse.core.runtime.PlatformObject
      extended by org.eclipse.core.internal.jobs.InternalJob
          extended by org.eclipse.core.runtime.jobs.Job
              extended by com.ibm.carma.ui.job.AbstractCarmaJob
                  extended by com.ibm.carma.ui.job.OpenMemberJob
All Implemented Interfaces:
java.lang.Comparable, org.eclipse.core.runtime.IAdaptable

public class OpenMemberJob
extends AbstractCarmaJob

This user Job downloads the CARMA member contents from the host and opens the contents in an editor in the workbench.

This class is not intended to be extended, but may be instantiated.

Since:
7.0

Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class org.eclipse.core.runtime.jobs.Job
ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING
 
Constructor Summary
OpenMemberJob(java.lang.String name, CARMAMember member, org.eclipse.ui.IWorkbenchPage page)
           
 
Method Summary
 void setEditorId(java.lang.String editorId)
          Specify the editor that should be used to open the CARMA member specified in the constructor.
 
Methods inherited from class com.ibm.carma.ui.job.AbstractCarmaJob
displayCustomReturns, displayCustomReturns, displayCustomReturns, displayCustomReturns, getActionFromReturns, getActionName
 
Methods inherited from class org.eclipse.core.runtime.jobs.Job
addJobChangeListener, belongsTo, cancel, done, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, removeJobChangeListener, schedule, schedule, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, shouldRun, shouldSchedule, sleep, wakeUp, wakeUp
 
Methods inherited from class org.eclipse.core.internal.jobs.InternalJob
compareTo, toString
 
Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapter
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Constructor Detail

OpenMemberJob

public OpenMemberJob(java.lang.String name,
                     CARMAMember member,
                     org.eclipse.ui.IWorkbenchPage page)
Parameters:
name - name of the job
member - CARMA member to download and open in a editor
page - the workbench page the editor should be opened in
Method Detail

setEditorId

public void setEditorId(java.lang.String editorId)
Specify the editor that should be used to open the CARMA member specified in the constructor. The editor Id will be matched to an editor extension in the workbench. If the editor cannot be located, the default editor for the member will be used.

Parameters:
editorId - the identifier of the editor that should be used to open the CARMA member