Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
SheetManager | 35 | 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.sheet; | |
21 | ||
22 | import java.util.List; | |
23 | ||
24 | import org.xwiki.bridge.DocumentModelBridge; | |
25 | import org.xwiki.component.annotation.Role; | |
26 | import org.xwiki.model.reference.DocumentReference; | |
27 | ||
28 | /** | |
29 | * Interface used to retrieve the list of sheets available for a given document. | |
30 | * | |
31 | * @version $Id: 562a5637c01f1d3e2d0707379013e885e9f3d766 $ | |
32 | * @since 3.2M3 | |
33 | */ | |
34 | @Role | |
35 | public interface SheetManager | |
36 | { | |
37 | /** | |
38 | * Returns the list of sheets available for a given XWiki document in the current execution context. | |
39 | * <p> | |
40 | * Note: We can't use a document reference because the document might have unsaved objects. The create forms usually | |
41 | * display an unsaved document that has some objects attached. | |
42 | * <p> | |
43 | * If this method fails for some reason to retrieve the sheets it shound't throw an exception but return an empty | |
44 | * list and log an appropriate warning message instead. | |
45 | * | |
46 | * @param document a XWiki document | |
47 | * @param action the action for which to retrieve the list of sheets ('view', 'edit' etc.); you can pass | |
48 | * {@code null} or an empty string as a substitute for any action | |
49 | * @return the list of sheets available for the given document and the specified action; these are sheets designed | |
50 | * to be displayed when the specified action is performed on the given document (e.g. view sheets, edit | |
51 | * sheets etc.) | |
52 | */ | |
53 | List<DocumentReference> getSheets(DocumentModelBridge document, String action); | |
54 | } |