1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.security.authorization.testwikibuilding

File HasDocuments.java

 

Code metrics

0
0
0
1
42
7
0
-
-
0
-

Classes

Class Line # Actions
HasDocuments 31 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.security.authorization.testwikibuilding;
21   
22    import com.xpn.xwiki.doc.XWikiDocument;
23   
24    /**
25    * This interface is used for building a mocked test setup for testing the authorization manager. Interface for entities
26    * that contain documents. I.e., a space.
27    *
28    * @since 4.2
29    * @version $Id: 902ef6511a17e1b5cf0f5d56e625a4bcbb051a04 $
30    */
 
31    public interface HasDocuments extends HasAcl
32    {
33    /**
34    * @param name The name of the document to add.
35    * @param creator The name of the creator. May be {\code null}.
36    * @param alt The pretty name of the document. (optional)
37    * @return an entity representing the document that holds the acl of the document.
38    */
39    HasAcl addDocument(String name, String creator, String alt);
40   
41    XWikiDocument removeDocument(String name);
42    }