Simple interface for controlling jobs, including possible ad-hoc executions, based on different runtime identifiers. It is extremely important to note that this interface makes absolutely no guarantees about whether or not calls to it are executed synchronously or asynchronously. The docs for specific implementations should be checked to ensure callers fully understand how the job will be run. More...
Public Member Functions | |
JobExecution | Run (IJob job, JobParameters jobParameters) |
Starts a job execution for the given IJob and JobParameters. If a JobExecution was able to be created successfully, it will always be returned by this method, regardless of whether or not the execution was successful. If there is a past JobExecution which has paused, the same JobExecution is returned instead of a new one created. A exception will only be thrown if there is a failure to start the job. If the job encounters some error while processing, the JobExecution will be returned, and the status will need to be inspected. More... | |
Detailed Description
Simple interface for controlling jobs, including possible ad-hoc executions, based on different runtime identifiers. It is extremely important to note that this interface makes absolutely no guarantees about whether or not calls to it are executed synchronously or asynchronously. The docs for specific implementations should be checked to ensure callers fully understand how the job will be run.
Member Function Documentation
JobExecution Summer.Batch.Core.Launch.IJobLauncher.Run | ( | IJob | job, |
JobParameters | jobParameters | ||
) |
Starts a job execution for the given IJob and JobParameters. If a JobExecution was able to be created successfully, it will always be returned by this method, regardless of whether or not the execution was successful. If there is a past JobExecution which has paused, the same JobExecution is returned instead of a new one created. A exception will only be thrown if there is a failure to start the job. If the job encounters some error while processing, the JobExecution will be returned, and the status will need to be inspected.
/summary>
- Parameters
-
job jobParameters
- Returns
- the JobExecution if it returns synchronously. If the implementation is asynchronous, the status might well be unknown
- Exceptions
-
JobExecutionAlreadyRunningException if the JobInstance identified by the properties already has an execution running JobRestartException if the job has been run before and circumstances that preclude a re-start JobInstanceAlreadyCompleteException if the job has been run before with the same parameters and completed successfully JobParametersInvalidException if the parameters are not valid for this job
Implemented in Summer.Batch.Core.Launch.Support.SimpleJobLauncher.
The documentation for this interface was generated from the following file:
- Summer.Batch.Core/Core/Launch/IJobLauncher.cs