Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
SecureQuery | 28 | 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.query; | |
21 | ||
22 | /** | |
23 | * Extends {@link Query} with various security related options. | |
24 | * | |
25 | * @version $Id: 8fe13c926ce42a6e0cb9cbd22bf90c52fd7d39f1 $ | |
26 | * @since 7.2M2 | |
27 | */ | |
28 | public interface SecureQuery extends Query | |
29 | { | |
30 | /** | |
31 | * @return true if the right of the current author (usually the content author of the context document or secure | |
32 | * document) should be checked | |
33 | */ | |
34 | boolean isCurrentAuthorChecked(); | |
35 | ||
36 | /** | |
37 | * @param checkCurrentAuthor true if the right of the current author (usually the content author of the context | |
38 | * document or secure document) should be checked | |
39 | * @return this query. | |
40 | */ | |
41 | SecureQuery checkCurrentAuthor(boolean checkCurrentAuthor); | |
42 | ||
43 | /** | |
44 | * @return true if the right of the current author should be checked (for example to filter results) | |
45 | */ | |
46 | boolean isCurrentUserChecked(); | |
47 | ||
48 | /** | |
49 | * @param checkCurrentUser true if the right of the current user should be checked (for example to filter results) | |
50 | * @return this query. | |
51 | */ | |
52 | SecureQuery checkCurrentUser(boolean checkCurrentUser); | |
53 | } |