View Javadoc
1   /*
2    * This file is part of ***  M y C o R e  ***
3    * See http://www.mycore.de/ for details.
4    *
5    * MyCoRe is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    *
10   * MyCoRe 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
13   * GNU General Public License for more details.
14   *
15   * You should have received a copy of the GNU General Public License
16   * along with MyCoRe.  If not, see <http://www.gnu.org/licenses/>.
17   */
18  
19  package org.mycore.wcms2.navigation;
20  
21  import org.jdom2.Element;
22  
23  import com.google.gson.JsonArray;
24  
25  /**
26   * 
27   * @author Matthias Eichner
28   */
29  public interface MCRWCMSSectionProvider extends MCRWCMSJSONProvider<Element, JsonArray> {
30  
31      String JSON_TITLE = "title";
32  
33      String JSON_LANG = "lang";
34  
35      String JSON_DATA = "data";
36  
37      /**
38       * 
39       */
40      @Override
41      Element fromJSON(JsonArray jsonSection);
42  
43      /**
44       * Converts a MyCoRe Webpage to a json array. The array contains
45       * all the section elements of the webpage including their content.
46       * <p>
47       * [<br> 
48       *   {title: "title of section", lang: "de", data: "&lt;xml&gt;content of section&lt;/xml&gt;"},<br> 
49       *   {title: "title of section 2", lang: "en", data: "&lt;xml&gt;content of section 2&lt;/xml&gt;"}<br> 
50       * ]
51       * </p>
52       */
53      @Override
54      JsonArray toJSON(Element object);
55  
56  }