1 /* This file is part of the project "Hilbert II" - http://www.qedeq.org" target="alexandria_uri">http://www.qedeq.org 2 * 3 * Copyright 2000-2014, Michael Meyling <mime@qedeq.org>. 4 * 5 * "Hilbert II" is free software; you can redistribute 6 * it and/or modify it under the terms of the GNU General Public 7 * License as published by the Free Software Foundation; either 8 * version 2 of the License, or (at your option) any later version. 9 * 10 * This program 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 16 package org.qedeq.kernel.se.base.module; 17 18 19 /** 20 * Header of a QEDEQ file. The header specifies such things as the location of the file, 21 * the title and abstract of that module, imports and exports. 22 * 23 * @author Michael Meyling 24 */ 25 public interface Header { 26 27 /** 28 * Get module specification. 29 * 30 * @return Module specification. 31 */ 32 public Specification getSpecification(); 33 34 /** 35 * Get module title. 36 * 37 * @return Module title. 38 */ 39 public LatexList getTitle(); 40 41 /** 42 * Get module summary. 43 * 44 * @return Module abstract. 45 */ 46 public LatexList getSummary(); 47 48 /** 49 * Get author list. 50 * 51 * @return Module author list. 52 */ 53 public AuthorList getAuthorList(); 54 55 /** 56 * Get list of needed modules. 57 * 58 * @return Import list. 59 */ 60 public ImportList getImportList(); 61 62 /** 63 * Get list of modules, that use this module. 64 * 65 * @return Used by list. 66 */ 67 public UsedByList getUsedByList(); 68 69 /** 70 * Get email address of module administrator. 71 * 72 * @return Email address of module administrator. 73 */ 74 public String getEmail(); 75 }