Entry point for browsing executions of running or historical jobs and steps. Since the data may be re-hydrated from persistent storage, it may not contain volatile fields that would have been present when the execution was active. More...
Public Member Functions | |
| IList< JobInstance > | GetJobInstances (string jobName, int start, int count) |
| Fetches JobInstance values in descending order of creation (and therefore usually of first execution). More... | |
| JobExecution | GetJobExecution (long executionId) |
| Retrieves a JobExecution by its id. The complete object graph for this execution should be returned (unless otherwise indicated) including the parent JobInstance and associated ExecutionContext and StepExecution instances (also including their execution contexts). More... | |
| StepExecution | GetStepExecution (long jobExecutionId, long stepExecutionId) |
| Retrieves a StepExecution by its id and parent JobExecution id. The execution context for the step should be available in the result, and the parent job execution should have its primitive properties, but may not contain the job instance information. More... | |
| JobInstance | GetJobInstance (long instanceId) |
| Gets the Job Instance given its instance id More... | |
| IList< JobExecution > | GetJobExecutions (JobInstance jobInstance) |
| Retrieves job executions by their job instance. The corresponding step executions may not be fully hydrated (e.g. their execution context may be missing), depending on the implementation. Use GetStepExecution(Long, Long) to hydrate them in that case. More... | |
| ISet< JobExecution > | FindRunningJobExecutions (string jobName) |
| Retrieves running job executions. The corresponding step executions may not be fully hydrated (e.g. their execution context may be missing), depending on the implementation. Use GetStepExecution(Long, Long) to hydrate them in that case. More... | |
| IList< string > | GetJobNames () |
| Queries the repository for all unique JobInstance names (sorted alphabetically). More... | |
| int | GetJobInstanceCount (string jobName) |
| Queries the repository for the number of unique JobInstances associated with the supplied job name. More... | |
Detailed Description
Entry point for browsing executions of running or historical jobs and steps. Since the data may be re-hydrated from persistent storage, it may not contain volatile fields that would have been present when the execution was active.
Member Function Documentation
| ISet<JobExecution> Summer.Batch.Core.Explore.IJobExplorer.FindRunningJobExecutions | ( | string | jobName | ) |
Retrieves running job executions. The corresponding step executions may not be fully hydrated (e.g. their execution context may be missing), depending on the implementation. Use GetStepExecution(Long, Long) to hydrate them in that case.
- Parameters
-
jobName the name of the job
- Returns
- the set of running executions for jobs with the specified name
Implemented in Summer.Batch.Core.Explore.Support.SimpleJobExplorer.
| JobExecution Summer.Batch.Core.Explore.IJobExplorer.GetJobExecution | ( | long | executionId | ) |
Retrieves a JobExecution by its id. The complete object graph for this execution should be returned (unless otherwise indicated) including the parent JobInstance and associated ExecutionContext and StepExecution instances (also including their execution contexts).
- Parameters
-
executionId the job execution id
- Returns
- the JobExecution with this id, or null if not found
Implemented in Summer.Batch.Core.Explore.Support.SimpleJobExplorer.
| IList<JobExecution> Summer.Batch.Core.Explore.IJobExplorer.GetJobExecutions | ( | JobInstance | jobInstance | ) |
Retrieves job executions by their job instance. The corresponding step executions may not be fully hydrated (e.g. their execution context may be missing), depending on the implementation. Use GetStepExecution(Long, Long) to hydrate them in that case.
- Parameters
-
jobInstance the JobInstance to query
- Returns
- the set of all executions for the specified JobInstance
Implemented in Summer.Batch.Core.Explore.Support.SimpleJobExplorer.
| JobInstance Summer.Batch.Core.Explore.IJobExplorer.GetJobInstance | ( | long | instanceId | ) |
Gets the Job Instance given its instance id
- Parameters
-
instanceId
- Returns
- the JobInstance with this id, or null
Implemented in Summer.Batch.Core.Explore.Support.SimpleJobExplorer.
| int Summer.Batch.Core.Explore.IJobExplorer.GetJobInstanceCount | ( | string | jobName | ) |
Queries the repository for the number of unique JobInstances associated with the supplied job name.
- Parameters
-
jobName the name of the job to query for
- Returns
- the number of JobInstances that exist within the associated job repository
- Exceptions
-
T:Summer.Batch.Core.Launch.NoSuchJobException If no jobInstance could be located for the given name
Implemented in Summer.Batch.Core.Explore.Support.SimpleJobExplorer.
| IList<JobInstance> Summer.Batch.Core.Explore.IJobExplorer.GetJobInstances | ( | string | jobName, |
| int | start, | ||
| int | count | ||
| ) |
Fetches JobInstance values in descending order of creation (and therefore usually of first execution).
- Parameters
-
jobName the name of the job to query start the start index of the instances to return count the maximum number of instances to return
- Returns
- the JobInstance values up to a maximum of count values
Implemented in Summer.Batch.Core.Explore.Support.SimpleJobExplorer.
| IList<string> Summer.Batch.Core.Explore.IJobExplorer.GetJobNames | ( | ) |
Queries the repository for all unique JobInstance names (sorted alphabetically).
- Returns
- the set of job names that have been executed
Implemented in Summer.Batch.Core.Explore.Support.SimpleJobExplorer.
| StepExecution Summer.Batch.Core.Explore.IJobExplorer.GetStepExecution | ( | long | jobExecutionId, |
| long | stepExecutionId | ||
| ) |
Retrieves a StepExecution by its id and parent JobExecution id. The execution context for the step should be available in the result, and the parent job execution should have its primitive properties, but may not contain the job instance information.
- Parameters
-
jobExecutionId the parent job execution id stepExecutionId the step execution id
- Returns
- the StepExecution with this id, or null if not found
Implemented in Summer.Batch.Core.Explore.Support.SimpleJobExplorer.
The documentation for this interface was generated from the following file:
- Summer.Batch.Core/Core/Explore/IJobExplorer.cs