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

File TestSpace.java

 

Code metrics

0
0
0
1
64
12
0
-
-
0
-

Classes

Class Line # Actions
TestSpace 34 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   
21    package org.xwiki.security.authorization.testwikis;
22   
23    import java.util.Collection;
24   
25    import org.xwiki.model.reference.DocumentReference;
26    import org.xwiki.model.reference.SpaceReference;
27   
28    /**
29    * Public interface of test entities representing spaces.
30    *
31    * @version $Id: 1e6d3433ee71e8f7db98f2fc2c509ed416e9d3f9 $
32    * @since 5.0M2
33    */
 
34    public interface TestSpace extends SecureTestEntity
35    {
36    /**
37    * @return a reference to the space represented by this test entity.
38    */
39    SpaceReference getSpaceReference();
40   
41    /**
42    * Retrieve a test entity representing a document in this space.
43    * @param name name of the document.
44    * @return a test document entity if found, null otherwise.
45    */
46    TestDocument getDocument(String name);
47   
48    /**
49    * Retrieve a test entity representing a document in this space.
50    * @param reference reference to a document.
51    * @return a test document entity if found, null otherwise.
52    */
53    TestDocument getDocument(DocumentReference reference);
54   
55    /**
56    * @return a collection of all test entities representing documents in this space.
57    */
58    Collection<TestDocument> getDocuments();
59   
60    /**
61    * @return the alternate description for this test document.
62    */
63    String getDescription();
64    }