IJob

All Known Subinterfaces:

IBlackboardInteractingJob<BlackboardType>, ICompositeJob, IPrePostJob

All Known Implementing Classes:

AbstractBlackboardInteractingJob, AbstractCompositeJob, AbstractExtendableJob, AbstractJob, AbstractOAWWorkflowJobBridge, AbstractWorkflowExtensionJob, BlackboardBasedWorkflow, CheckEMFConstraintsJob, ModelValidationJob, MWE2BlackboardWorkflowComponentBridge, MWE2SequentialJob, MWE2WorkflowComponentBridge, ParallelBlackboardInteractingJob, ParallelJob, PerformOAWCheckValidation, PrepareXTextPartitionJob, QVTOTransformationJob, SavePartitionToDiskJob, SequentialBlackboardInteractingJob, SequentialJob, ShowValidationErrorsJob, UIBasedWorkflow, Workflow, XpandGeneratorJob, XTextGeneratorBlackboardJob, XTextGeneratorJob
```
public interface IJob
```
Interface for jobs to be added to a workflow (IWorkflow). If jobs depend on each other (i.e. the execution depends on a certain order) a composite job should be implemented which then manages the child jobs.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cleanup(IProgressMonitor monitor)`	Clean up all temporary side effects of this job.
`void`	`execute(IProgressMonitor monitor)`	Execute the job.
`String`	`getName()`	Supply a name of this job.

- Method Detail
  - execute
```
void execute(IProgressMonitor monitor)
      throws JobFailedException,
             UserCanceledException
```
    Execute the job. In case of an error throw an exception with a meaningful name which can be understood by a user.
    
    Parameters:
    
    monitor - the monitor
    
    Throws:
    
    JobFailedException - the job failed
    
    UserCanceledException - the user has chosen to abort the job
  - cleanup
```
void cleanup(IProgressMonitor monitor)
      throws CleanupFailedException
```
    Clean up all temporary side effects of this job. This method will always be called after executing this job to remove automatically created files and to leave the environment in a state in which the whole workflow run can be started again with the same results (i.e. in which executed can be called again). Usually, cleanup is called after the whole workflow is completed to allow other jobs to use intermediate results. In some cases, cleanup can be called earlier. However, in those cases, later jobs might not be able to access the intermediate data anymore.
    
    Parameters:
    
    monitor - the monitor
    
    Throws:
    
    CleanupFailedException - Thrown if a critical error occurred during clean up so that the whole workflow should abort cleaning up further jobs.
  - getName
```
String getName()
```
    Supply a name of this job. This could be used for a progress monitor.
    
    Returns:
    
    the name of the job