Package org.bonitasoft.engine.scheduler

Interface JobService

All Known Implementing Classes:

JobServiceImpl

public interface JobService

Since:

6.1

Author:

Celine Souchet

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_DESCRIPTOR
static final String	JOB_LOG
static final String	JOB_PARAMETER

Method Summary

Modifier and Type	Method	Description
SJobDescriptor	createJobDescriptor(SJobDescriptor sJobDescriptor)	Create a new job descriptor
SJobLog	createJobLog(SJobLog sJobLog)	Create a new job log
SJobParameter	createJobParameter(SJobParameter sJobParameter, long jobDescriptorId)	Create a new job parameter
List<SJobParameter>	createJobParameters(List<SJobParameter> parameters, long jobDescriptorId)	Create new job parameters
void	deleteAllJobDescriptors()	Delete all job descriptors
void	deleteJobDescriptor(long id)	Delete the specified job descriptor
void	deleteJobDescriptor(SJobDescriptor sJobDescriptor)	Delete the specified job descriptor
void	deleteJobDescriptorByJobName(String jobName)	Delete a job descriptor corresponding to the given job name
void	deleteJobLog(long id)	Delete the specified job log
void	deleteJobLog(SJobLog sJobLog)	Delete the specified job log
void	deleteJobLogs(long jobDescriptorId)	Delete all SJobLog of a specific SJobDescriptor
void	deleteJobParameter(long id)	Delete the specified job parameter
void	deleteJobParameter(SJobParameter sJobParameter)	Delete the specified job parameter
List<SFailedJob>	getFailedJobs(int startIndex, int maxResults)	Get list of failed jobs
SJobDescriptor	getJobDescriptor(long id)	Get a specific job descriptor
SJobLog	getJobLog(long id)	Get a specific job log
List<SJobLog>	getJobLogs(long jobDescriptorId, int fromIndex, int maxResults)	Get all SJobLog of a specific SJobDescriptor
SJobParameter	getJobParameter(long id)	Get a specific job parameter
List<SJobParameter>	getJobParameters(Long jobDescriptorId)	get parameters of a job
long	getNumberOfJobDescriptors(QueryOptions queryOptions)	Get total number of job descriptors
long	getNumberOfJobLogs(QueryOptions queryOptions)	Get total number of job logs
void	logJobError(Throwable jobException, Long jobDescriptorId)	log an error on a job
List<SJobDescriptor>	searchJobDescriptors(QueryOptions queryOptions)	Search all job descriptors according to specific criteria
List<SJobLog>	searchJobLogs(QueryOptions queryOptions)	Search all job logs according to specific criteria
List<SJobParameter>	setJobParameters(long jobDescriptorId, List<SJobParameter> parameters)	Delete jobs parameters corresponding to the job descriptor, if exist.
void	updateJobLog(SJobLog jobLog, EntityUpdateDescriptor descriptor)	Update a SJobLog

Field Details

JOB_DESCRIPTOR

static final String JOB_DESCRIPTOR

See Also:

• Constant Field Values

JOB_PARAMETER

static final String JOB_PARAMETER

See Also:

• Constant Field Values

JOB_LOG

static final String JOB_LOG

See Also:

• Constant Field Values

Method Details

createJobDescriptor

SJobDescriptor createJobDescriptor(SJobDescriptor sJobDescriptor)
                            throws SJobDescriptorCreationException

Create a new job descriptor

Parameters:

sJobDescriptor - JobDescriptor to create

Returns:

The created jobDescriptor

Throws:

SJobDescriptorCreationException

Since:

6.1

deleteJobDescriptor

void deleteJobDescriptor(long id)
                  throws SJobDescriptorNotFoundException,
SJobDescriptorReadException,
SJobDescriptorDeletionException

Delete the specified job descriptor

Parameters:

id - Identifier of job descriptor to delete

Throws:

SJobDescriptorReadException

SJobDescriptorNotFoundException

SJobDescriptorDeletionException

Since:

6.1

deleteJobDescriptor

void deleteJobDescriptor(SJobDescriptor sJobDescriptor)
                  throws SJobDescriptorDeletionException

Delete the specified job descriptor

Parameters:

sJobDescriptor - JobDescriptor to delete

Throws:

SJobDescriptorDeletionException

Since:

6.1

deleteAllJobDescriptors

void deleteAllJobDescriptors()
                      throws SJobDescriptorDeletionException

Delete all job descriptors

Throws:

SJobDescriptorDeletionException

Since:

6.4

deleteJobDescriptorByJobName

void deleteJobDescriptorByJobName(String jobName)
                           throws SJobDescriptorDeletionException

Delete a job descriptor corresponding to the given job name

Parameters:

jobName - name of job we want the jobDsecriptor to be deleted

Throws:

SJobDescriptorDeletionException

Since:

6.3

getJobDescriptor

SJobDescriptor getJobDescriptor(long id)
                         throws SJobDescriptorReadException

Get a specific job descriptor

Parameters:

id - Identifier of job descriptor

Returns:

Null if the job descriptor doesn't exist, else the SJobDescriptor corresponding to the identifier

Throws:

SJobDescriptorReadException

Since:

6.1

getNumberOfJobDescriptors

long getNumberOfJobDescriptors(QueryOptions queryOptions)
                        throws SBonitaReadException

Get total number of job descriptors

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

total number of job logs

Throws:

SBonitaReadException

searchJobDescriptors

List<SJobDescriptor> searchJobDescriptors(QueryOptions queryOptions)
                                   throws SBonitaReadException

Search all job descriptors according to specific criteria

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

A list of SJobParameter objects

Throws:

SBonitaReadException

Since:

6.1

createJobParameters

List<SJobParameter> createJobParameters(List<SJobParameter> parameters,
 long jobDescriptorId)
                                 throws SJobParameterCreationException

Create new job parameters

Parameters:

parameters - JobParameters to create

jobDescriptorId - Identifier of job descriptor

Returns:

Throws:

SJobParameterCreationException

Since:

6.2

setJobParameters

List<SJobParameter> setJobParameters(long jobDescriptorId,
 List<SJobParameter> parameters)
                              throws SJobParameterCreationException

Delete jobs parameters corresponding to the job descriptor, if exist. After, create new job parameters

Parameters:

jobDescriptorId -

parameters -

Returns:

A list of new SJobParameter objects

Throws:

SJobParameterCreationException

Since:

6.1

createJobParameter

SJobParameter createJobParameter(SJobParameter sJobParameter,
 long jobDescriptorId)
                          throws SJobParameterCreationException

Create a new job parameter

Parameters:

sJobParameter - JobParameter to create

jobDescriptorId - Identifier of job descriptor

Returns:

Throws:

SJobParameterCreationException

Since:

6.2

deleteJobParameter

void deleteJobParameter(long id)
                 throws SJobParameterNotFoundException,
SJobParameterReadException,
SJobParameterDeletionException

Delete the specified job parameter

Parameters:

id - Identifier of job parameter to delete

Throws:

SJobParameterReadException

SJobParameterNotFoundException

SJobParameterDeletionException

Since:

6.1

deleteJobParameter

void deleteJobParameter(SJobParameter sJobParameter)
                 throws SJobParameterDeletionException

Delete the specified job parameter

Parameters:

sJobParameter - JobParameter to delete

Throws:

SJobParameterDeletionException

Since:

6.1

getJobParameter

SJobParameter getJobParameter(long id)
                       throws SJobParameterNotFoundException,
SJobParameterReadException

Get a specific job parameter

Parameters:

id - Identifier of job parameter

Returns:

Throws:

SJobParameterReadException

SJobParameterNotFoundException

Since:

6.1

getJobParameters

List<SJobParameter> getJobParameters(Long jobDescriptorId)
                              throws SBonitaReadException

get parameters of a job

Throws:

SBonitaReadException

createJobLog

SJobLog createJobLog(SJobLog sJobLog)
              throws SJobLogCreationException

Create a new job log

Parameters:

sJobLog - JobLog to create

Returns:

Throws:

SJobLogCreationException

Since:

6.2

deleteJobLog

void deleteJobLog(long id)
           throws SJobLogDeletionException,
SBonitaReadException

Delete the specified job log

Parameters:

id - Identifier of job log to delete

Throws:

SBonitaReadException

SJobLogDeletionException

Since:

6.1

deleteJobLog

void deleteJobLog(SJobLog sJobLog)
           throws SJobLogDeletionException

Delete the specified job log

Parameters:

sJobLog - JobLog to delete

Throws:

SJobLogDeletionException

Since:

6.1

getJobLog

SJobLog getJobLog(long id)
           throws SBonitaReadException

Get a specific job log

Parameters:

id - Identifier of job log

Returns:

Throws:

SBonitaReadException

Since:

6.1

getNumberOfJobLogs

long getNumberOfJobLogs(QueryOptions queryOptions)
                 throws SBonitaReadException

Get total number of job logs

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

total number of job logs

Throws:

SBonitaReadException

searchJobLogs

List<SJobLog> searchJobLogs(QueryOptions queryOptions)
                     throws SBonitaReadException

Search all job logs according to specific criteria

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

A list of SJobLog objects

Throws:

SBonitaReadException

Since:

6.1

getFailedJobs

List<SFailedJob> getFailedJobs(int startIndex,
 int maxResults)
                        throws SFailedJobReadException

Get list of failed jobs

Parameters:

startIndex -

maxResults -

Returns:

A list of SFailedJob objects

Throws:

SFailedJobReadException

Since:

6.2

updateJobLog

void updateJobLog(SJobLog jobLog,
 EntityUpdateDescriptor descriptor)
           throws SJobLogUpdatingException

Update a SJobLog

Parameters:

jobLog - The log to update

descriptor -

Throws:

SJobLogUpdatingException

Since:

6.4.0

deleteJobLogs

void deleteJobLogs(long jobDescriptorId)
            throws SJobLogDeletionException,
SBonitaReadException

Delete all SJobLog of a specific SJobDescriptor

Parameters:

jobDescriptorId - The identifier of the SJobDescriptor

Throws:

SBonitaReadException

SJobLogDeletionException

Since:

6.4.0

getJobLogs

List<SJobLog> getJobLogs(long jobDescriptorId,
 int fromIndex,
 int maxResults)
                  throws SBonitaReadException

Get all SJobLog of a specific SJobDescriptor

Parameters:

jobDescriptorId - The identifier of the SJobDescriptor

fromIndex - The index of the first element of the list

maxResults - The nulber max of elements of the list

Returns:

A list of SJobLog

Throws:

SBonitaReadException

Since:

6.4.0

logJobError

void logJobError(Throwable jobException,
 Long jobDescriptorId)
          throws SBonitaReadException,
SJobLogUpdatingException,
SJobLogCreationException,
SJobDescriptorReadException

log an error on a job

Parameters:

jobException - the exception

jobDescriptorId - the id of the job

Throws:

SBonitaReadException

SJobLogUpdatingException

SJobLogCreationException

SJobDescriptorReadException

Since:

7.2.0