com.ibm.carma.ui.job
Class CheckoutJob

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.CustomActionJob<com.ibm.carma.model.CARMAContent>
                      extended by com.ibm.carma.ui.job.CheckoutJob
All Implemented Interfaces:
java.lang.Comparable, org.eclipse.core.runtime.IAdaptable

public class CheckoutJob
extends CustomActionJob<com.ibm.carma.model.CARMAContent>

This user Job performs the checkout action an members passed to the Constructor.

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


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
CheckoutJob(java.lang.String name, com.ibm.carma.model.CARMAContent[] members)
           
 
Method Summary
 com.ibm.carma.model.CARMAReturn performCommand(com.ibm.carma.model.CARMAContent resource, org.eclipse.core.runtime.IProgressMonitor monitor)
          By default this method calls the generic perform command action, but can be overriden to call any method on the passed CARMA Resource
 
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, toString, wakeUp, wakeUp, yieldRule
 
Methods inherited from class org.eclipse.core.internal.jobs.InternalJob
compareTo
 
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

CheckoutJob

public CheckoutJob(java.lang.String name,
                   com.ibm.carma.model.CARMAContent[] members)
Parameters:
name - The name of the Job.
members - The resources to checkout
Method Detail

performCommand

public com.ibm.carma.model.CARMAReturn performCommand(com.ibm.carma.model.CARMAContent resource,
                                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                                               throws org.eclipse.core.runtime.CoreException,
                                                      com.ibm.carma.transport.NotConnectedException,
                                                      com.ibm.carma.UnsupportedCARMAOperationException,
                                                      com.ibm.carma.transport.NotSynchronizedException
Description copied from class: CustomActionJob
By default this method calls the generic perform command action, but can be overriden to call any method on the passed CARMA Resource

Extenders are responsible for filling the custom parameters of the called action.

Overrides:
performCommand in class CustomActionJob<com.ibm.carma.model.CARMAContent>
Returns:
the CARMAReturn value associated with the call
Throws:
org.eclipse.core.runtime.CoreException
com.ibm.carma.transport.NotConnectedException
com.ibm.carma.UnsupportedCARMAOperationException
com.ibm.carma.transport.NotSynchronizedException
See Also:
CustomActionUtil, CustomActionParameterDialog, CustomActionParameterManager