|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ModuleReferenceList | Line # 31 | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
No Tests | |||
1 | package org.qedeq.kernel.bo; | |
2 | ||
3 | import org.qedeq.kernel.common.ModuleContext; | |
4 | ||
5 | ||
6 | /* $Id: ModuleReferenceList.java,v 1.1 2008/07/26 07:58:29 m31 Exp $ | |
7 | * | |
8 | * This file is part of the project "Hilbert II" - http://www.qedeq.org | |
9 | * | |
10 | * Copyright 2000-2008, Michael Meyling <mime@qedeq.org>. | |
11 | * | |
12 | * "Hilbert II" is free software; you can redistribute | |
13 | * it and/or modify it under the terms of the GNU General Public | |
14 | * License as published by the Free Software Foundation; either | |
15 | * version 2 of the License, or (at your option) any later version. | |
16 | * | |
17 | * This program is distributed in the hope that it will be useful, | |
18 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | * GNU General Public License for more details. | |
21 | */ | |
22 | ||
23 | /** | |
24 | * Represents a reference list of modules. Every entry has a symbolic name for one referenced QEDEQ | |
25 | * module. This module label acts as a prefix for all references to that module. The module label | |
26 | * must be an unique String. | |
27 | * | |
28 | * @version $Revision: 1.1 $ | |
29 | * @author Michael Meyling | |
30 | */ | |
31 | public interface ModuleReferenceList { | |
32 | ||
33 | /** | |
34 | * Get number of module references. | |
35 | * | |
36 | * @return Number of module references. | |
37 | */ | |
38 | public int size(); | |
39 | ||
40 | /** | |
41 | * Get label for certain module. | |
42 | * | |
43 | * @param index Entry index. | |
44 | * @return Label of module. | |
45 | */ | |
46 | public String getLabel(int index); | |
47 | ||
48 | /** | |
49 | * Get properties of referenced module. | |
50 | * | |
51 | * @param index Entry index. | |
52 | * @return Module properties for that module. | |
53 | */ | |
54 | public QedeqBo getQedeqBo(int index); | |
55 | ||
56 | /** | |
57 | * Get import context of referenced module. | |
58 | * | |
59 | * @param index Entry index. | |
60 | * @return Context for that module. | |
61 | */ | |
62 | public ModuleContext getModuleContext(int index); | |
63 | ||
64 | /** | |
65 | * Get QedeqBo of referenced module via label. Might be <code>null</code>. | |
66 | * | |
67 | * @param label Label for referenced module or <code>null</code> if not found. | |
68 | * @return Module properties for that module. | |
69 | */ | |
70 | public QedeqBo getQedeqBo(String label); | |
71 | ||
72 | } |
|