Classes

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

Class WikiProvisioningJobExecutor

Class WikiProvisioningJobExecutor	Line # 33	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.wiki.provisioning;
21
22		import java.util.List;
23
24		import org.xwiki.component.annotation.Role;
25
26		/**
27		* Executor that manage jobs that provision wikis.
28		*
29		* @since 5.3M3
30		* @version $Id: cbbb61d99191df124ba1bcff35ce144e6b7bbd41 $
31		*/
32		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
33		public interface WikiProvisioningJobExecutor
34		{
35		/**
36		* Create a job and execute it.
37		*
38		* @param wikiId id of the wiki to provision
39		* @param provisioningJobName name of the WikiProvisioningJob component to use
40		* @param parameter parameter used by the wiki provisioning job, depending of its implementation.
41		* @return the created job.
42		* @throws WikiProvisioningJobException if problems occur
43		*/
44		WikiProvisioningJob createAndExecuteJob(String wikiId, String provisioningJobName, Object parameter) throws
45		WikiProvisioningJobException;
46
47		/**
48		* Get a wiki provisioning job.
49		*
50		* @param jobId Id of the job
51		* @return the job status
52		* @throws WikiProvisioningJobException if problems occur
53		*/
54		WikiProvisioningJob getJob(List<String> jobId) throws WikiProvisioningJobException;
55		}