1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.component.wiki.internal

File WikiComponentManagerContext.java

 

Code metrics

0
0
0
1
58
12
0
-
-
0
-

Classes

Class Line # Actions
WikiComponentManagerContext 33 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

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.component.wiki.internal;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.model.reference.DocumentReference;
24    import org.xwiki.model.reference.EntityReference;
25   
26    /**
27    * Utility class allowing to manipulate context information.
28    *
29    * @version $Id: 82fd84af0ec48e20ff6d9b3e0f0d479a4c5cc365 $
30    * @since 4.3M2
31    */
32    @Role
 
33    public interface WikiComponentManagerContext
34    {
35    /**
36    * @return A reference to the context user.
37    */
38    DocumentReference getCurrentUserReference();
39   
40    /**
41    * @return A reference to the context document.
42    */
43    EntityReference getCurrentEntityReference();
44   
45    /**
46    * Set the context user.
47    *
48    * @param reference A reference to the context user to set
49    */
50    void setCurrentUserReference(DocumentReference reference);
51   
52    /**
53    * Set the context document.
54    *
55    * @param reference A reference to the context document to set
56    */
57    void setCurrentEntityReference(EntityReference reference);
58    }