Classes

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

Class WikiCreator

Class WikiCreator	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.platform.wiki.creationjob;
21
22		import org.xwiki.component.annotation.Role;
23		import org.xwiki.job.Job;
24		import org.xwiki.job.event.status.JobStatus;
25
26		/**
27		* Component to create a wiki and perform actions during the creation.
28		*
29		* @version $Id: 47e0dbb040816bfd083c1f11fbe1417d39f1a3d3 $
30		* @since 7.0M2
31		*/
32		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
33		public interface WikiCreator
34		{
35		/**
36		* Start an asynchronous wiki creation.
37		*
38		* @param request a wiki creation request containing all the information about the wiki to create
39		* @throws WikiCreationException if problem occurs
40		*
41		* @return the job of the wiki creation
42		*/
43		Job createWiki(WikiCreationRequest request) throws WikiCreationException;
44
45		/**
46		* @param wikiId id of the wiki which is creatincreatorjoby a job
47		* @return the status of the wiki crcreatorjobion job
48		*/
49		JobStatus getJobStatus(String wikiId);
50		}