org.finra.herd.service

Interface JobService

All Known Implementing Classes:

JobServiceImpl

public interface JobService

The job service.

Method Summary

Modifier and Type	Method and Description
Job	createAndStartJob(JobCreateRequest jobCreateRequest) Creates and starts a new job asynchronously.
Job	deleteJob(String jobId, JobDeleteRequest jobDeleteRequest) Deletes a currently running job and preserves the job state in history.
Job	getJob(String id, boolean verbose) Gets the details of a previously submitted job.
JobSummaries	getJobs(String namespace, String jobName, JobStatusEnum jobStatus, org.joda.time.DateTime startTime, org.joda.time.DateTime endTime) Gets a list of job executions based on the specified filter parameters.
Job	signalJob(JobSignalRequest jobSignalRequest) Signals the job with the receive task.
Job	updateJob(String jobId, JobUpdateRequest jobUpdateRequest) Activates or suspends a job execution.

Method Detail

createAndStartJob

Job createAndStartJob(JobCreateRequest jobCreateRequest)
               throws Exception

Creates and starts a new job asynchronously.

Parameters:

jobCreateRequest - the information needed to create the job

Returns:

the created job information

Throws:

Exception - if any problems were encountered

deleteJob

Job deleteJob(String jobId,
              JobDeleteRequest jobDeleteRequest)
       throws Exception

Deletes a currently running job and preserves the job state in history. The method calls org.activiti.engine.RuntimeService.deleteProcessInstance(String, String) on the specified jobId.

Parameters:

jobId - the job id

jobDeleteRequest - the delete request

Returns:

the job that has been deleted

Throws:

Exception - if any problems were encountered

getJob

Job getJob(String id,
           boolean verbose)
    throws Exception

Gets the details of a previously submitted job.

Parameters:

id - the job id

Returns:

the job information

Throws:

Exception - if any problems were encountered

getJobs

JobSummaries getJobs(String namespace,
                     String jobName,
                     JobStatusEnum jobStatus,
                     org.joda.time.DateTime startTime,
                     org.joda.time.DateTime endTime)
              throws Exception

Gets a list of job executions based on the specified filter parameters.

Jobs' namespace to which you do not have READ permissions to will be omitted from the result.

Parameters:

namespace - an optional namespace filter

jobName - an optional job name filter

jobStatus - an optional job status filter

startTime - an optional job start time filter

endTime - an optional job end time filter

Returns:

the list of job summaries

Throws:

Exception - if any problems were encountered

signalJob

Job signalJob(JobSignalRequest jobSignalRequest)
       throws Exception

Signals the job with the receive task.

Parameters:

jobSignalRequest - the information needed to signal the job

Returns:

the created job information

Throws:

Exception

updateJob

Job updateJob(String jobId,
              JobUpdateRequest jobUpdateRequest)

Activates or suspends a job execution.

Parameters:

jobId - the job id

jobUpdateRequest - the job update request

Returns:

the job