com.bazaarvoice.emodb.job.api

Interface JobService

public interface JobService

Interface for submitting jobs and retrieving job status.

Method Summary

Modifier and Type	Method and Description
<Q,R> JobStatus<Q,R>	getJobStatus(JobIdentifier<Q,R> id) Queries for the status of a job created by submitJob(JobRequest)
boolean	pause() Stops the job service from processing any new jobs from the queue.
boolean	resume() Resumes the job service after a prior call to pause().
<Q,R> JobIdentifier<Q,R>	submitJob(JobRequest<Q,R> jobRequest) Submits a new job to the JobService.

Method Detail

submitJob

<Q,R> JobIdentifier<Q,R> submitJob(JobRequest<Q,R> jobRequest)

Submits a new job to the JobService.

Type Parameters:

Q - The job request type

R - The job response type

Parameters:

jobRequest - The request that encapsulates the job type and parameters.

Returns:

An identifier that can be used to query for the job's status

getJobStatus

<Q,R> JobStatus<Q,R> getJobStatus(JobIdentifier<Q,R> id)

Queries for the status of a job created by submitJob(JobRequest)

Type Parameters:

Q - The job request type

R - The job response type

Parameters:

id - The identifier returned from the original submit request.

Returns:

The job's status, or null if no such job exists

pause

boolean pause()

Stops the job service from processing any new jobs from the queue. Note that this does not affect any jobs already in progress at the time of the call.

Returns:

true if the service had been running and is now paused, false if this service was already paused

resume

boolean resume()

Resumes the job service after a prior call to pause().

Returns:

true if the service had been paused and is now running, false if this server was already running