Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
DocumentRestorerFromAttachedXAR | 36 | 0 | - | 0 | 0 |
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.workspacesmigrator.internal; | |
21 | ||
22 | import java.util.List; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | import org.xwiki.model.reference.DocumentReference; | |
26 | ||
27 | import com.xpn.xwiki.XWikiException; | |
28 | ||
29 | /** | |
30 | * Component to restore some document from a XAR attached to a wiki page. | |
31 | * | |
32 | * @version $Id: 9dc4744c64edc7cfc38170bf76c4dc14bbb1acbc $ | |
33 | * @since 5.3RC1 | |
34 | */ | |
35 | @Role | |
36 | public interface DocumentRestorerFromAttachedXAR | |
37 | { | |
38 | /** | |
39 | * Restore the desired documents from a xar. | |
40 | * @param docReference reference of the document that hold the XAR as attachment. | |
41 | * @param attachmentName the name of the attachment | |
42 | * @param documentsToRestore the list of documents we need to restore | |
43 | * @throws XWikiException if problems occur | |
44 | */ | |
45 | void restoreDocumentFromAttachedXAR(DocumentReference docReference, String attachmentName, | |
46 | List<DocumentReference> documentsToRestore) throws XWikiException; | |
47 | } |