Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
JobManager	36	0	-	0	0	-1.0 -	Show methods

Class JobManager

Class JobManager	Line # 36	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/*
2		* See the NOTICE file distributed with this work for additional
3		* information regarding copyright ownership.
4		*
5		* This is free software; you can redistribute it and/or modify it
6		* under the terms of the GNU Lesser General Public License as
7		* published by the Free Software Foundation; either version 2.1 of
8		* the License, or (at your option) any later version.
9		*
10		* This software is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public
16		* License along with this software; if not, write to the Free
17		* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18		* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19		*/
20		package org.xwiki.job;
21
22		import java.util.List;
23
24		import org.xwiki.component.annotation.Role;
25		import org.xwiki.job.event.status.JobStatus;
26
27		/**
28		* Proxy used to simplify execution of jobs.
29		*
30		* @version $Id: 0149915bd63a0911d42a9ef46ba65cb4bce9a861 $
31		* @since 4.0M1
32		* @deprecated since 6.1M2, use {@link JobExecutor} instead
33		*/
34		@Role
35		@Deprecated
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
36		public interface JobManager
37		{
38		/**
39		* @return the job currently running or the latest job, null if there is no job
40		*/
41		Job getCurrentJob();
42
43		/**
44		* Return job status corresponding to the provided id from the current executed job or stored history.
45		*
46		* @param id the id of the job
47		* @return the job status corresponding to the provided job id, null if none can be found
48		*/
49		JobStatus getJobStatus(String id);
50
51		/**
52		* Return job status corresponding to the provided id from the current executed job or stored history.
53		*
54		* @param id the id of the job
55		* @return the job status corresponding to the provided job id, null if none can be found
56		* @since 4.1M2
57		*/
58		JobStatus getJobStatus(List<String> id);
59
60		/**
61		* Start a new job with the provided identifier and wait until its finished.
62		*
63		* @param jobType the role hint of the job component
64		* @param request the request
65		* @return the created job
66		* @throws JobException error when creating the job
67		*/
68		Job executeJob(String jobType, Request request) throws JobException;
69
70		/**
71		* Add a new job in the queue of jobs to execute.
72		*
73		* @param jobType the role hint of the job component
74		* @param request the request
75		* @return the created job
76		* @throws JobException error when creating the job
77		*/
78		Job addJob(String jobType, Request request) throws JobException;
79
80		/**
81		* Add a new job in the queue of jobs to execute.
82		*
83		* @param job the job to execute
84		* @since 5.1M2
85		*/
86		void addJob(Job job);
87		}