Summer.Batch.Core.Explore.Support.SimpleJobExplorer Class Reference

Implementation of IJobExplorer using the injected DAOs. More...

Inheritance diagram for Summer.Batch.Core.Explore.Support.SimpleJobExplorer:
Summer.Batch.Core.Explore.IJobExplorer

Public Member Functions

 SimpleJobExplorer (IJobInstanceDao jobInstanceDao, IJobExecutionDao jobExecutionDao, IStepExecutionDao stepExecutionDao, IExecutionContextDao executionContextDao)
 Constructs a new SimpleJobExplorer with the specified DAOs. More...
 
IList< JobExecutionGetJobExecutions (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 to hydrate them in that case. More...
 
ISet< JobExecutionFindRunningJobExecutions (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...
 
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 executionId)
 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 JobInstance for the given instance id. More...
 
IList< JobInstanceGetJobInstances (string jobName, int start, int count)
 Fetches JobInstance values in descending order of creation (and therefore usually of first execution). 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

Implementation of IJobExplorer using the injected DAOs.

Constructor & Destructor Documentation

Summer.Batch.Core.Explore.Support.SimpleJobExplorer.SimpleJobExplorer ( IJobInstanceDao  jobInstanceDao,
IJobExecutionDao  jobExecutionDao,
IStepExecutionDao  stepExecutionDao,
IExecutionContextDao  executionContextDao 
)

Constructs a new SimpleJobExplorer with the specified DAOs.

Parameters
jobInstanceDaoThe job instance DAO.
jobExecutionDaoThe job execution DAO.
stepExecutionDaoThe step execution DAO.
executionContextDaoThe execution context DAO.

Member Function Documentation

ISet<JobExecution> Summer.Batch.Core.Explore.Support.SimpleJobExplorer.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
jobNamethe name of the job
Returns
the set of running executions for jobs with the specified name

Implements Summer.Batch.Core.Explore.IJobExplorer.

JobExecution Summer.Batch.Core.Explore.Support.SimpleJobExplorer.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
executionIdthe job execution id
Returns
the JobExecution with this id, or null if not found

Implements Summer.Batch.Core.Explore.IJobExplorer.

IList<JobExecution> Summer.Batch.Core.Explore.Support.SimpleJobExplorer.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 to hydrate them in that case.

Parameters
jobInstancethe JobInstance to query
Returns
the set of all executions for the specified JobInstance

Implements Summer.Batch.Core.Explore.IJobExplorer.

JobInstance Summer.Batch.Core.Explore.Support.SimpleJobExplorer.GetJobInstance ( long  instanceId)

Gets the JobInstance for the given instance id.

Parameters
instanceIdthe instance id
Returns
the JobInstance with this id, or null

Implements Summer.Batch.Core.Explore.IJobExplorer.

int Summer.Batch.Core.Explore.Support.SimpleJobExplorer.GetJobInstanceCount ( string  jobName)

Queries the repository for the number of unique JobInstances associated with the supplied job name.

Parameters
jobNamethe 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 found for the given name

Implements Summer.Batch.Core.Explore.IJobExplorer.

IList<JobInstance> Summer.Batch.Core.Explore.Support.SimpleJobExplorer.GetJobInstances ( string  jobName,
int  start,
int  count 
)

Fetches JobInstance values in descending order of creation (and therefore usually of first execution).

Parameters
jobNamethe name of the job to query
startthe start index of the instances to return
countthe maximum number of instances to return
Returns
the JobInstance values up to a maximum of count values

Implements Summer.Batch.Core.Explore.IJobExplorer.

IList<string> Summer.Batch.Core.Explore.Support.SimpleJobExplorer.GetJobNames ( )

Queries the repository for all unique JobInstance names (sorted alphabetically).

Returns
the set of job names that have been executed

Implements Summer.Batch.Core.Explore.IJobExplorer.

StepExecution Summer.Batch.Core.Explore.Support.SimpleJobExplorer.GetStepExecution ( long  jobExecutionId,
long  executionId 
)

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
jobExecutionIdthe parent job execution id
executionIdthe step execution id
Returns
the StepExecution with this id, or null if not found

Implements Summer.Batch.Core.Explore.IJobExplorer.


The documentation for this class was generated from the following file:
  • Summer.Batch.Core/Core/Explore/Support/SimpleJobExplorer.cs