|
1
|
/**
|
|
2
|
* Copyright (C) 2007 EDIT
|
|
3
|
* European Distributed Institute of Taxonomy
|
|
4
|
* http://www.e-taxonomy.eu
|
|
5
|
*
|
|
6
|
* The contents of this file are subject to the Mozilla Public License Version 1.1
|
|
7
|
* See LICENSE.TXT at the top of this package for the full license terms.
|
|
8
|
*/
|
|
9
|
package eu.etaxonomy.cdm.model.common;
|
|
10
|
|
|
11
|
import java.util.List;
|
|
12
|
|
|
13
|
public interface IMultiLanguageText {
|
|
14
|
|
|
15
|
/**
|
|
16
|
* @param language
|
|
17
|
* @return
|
|
18
|
*/
|
|
19
|
public String getText(Language language);
|
|
20
|
|
|
21
|
/**
|
|
22
|
* @param languageString
|
|
23
|
* @return String the previous text in the MultilanguageSet that was associated with the language
|
|
24
|
* defined in languageString, or null if there was no such text before. (A null return can also indicate that the text was previously null.)
|
|
25
|
*/
|
|
26
|
public LanguageString put(LanguageString languageString);
|
|
27
|
|
|
28
|
/**
|
|
29
|
* @param languageString
|
|
30
|
* @return String the previous text in the MultilanguageSet that was associated with the language
|
|
31
|
* defined in languageString, or null if there was no such text before. (A null return can also indicate that the text was previously null.)
|
|
32
|
* @deprecated should follow the put semantic of maps, this method will be removed in v4.0
|
|
33
|
* Use the {@link #put(LanguageString) put} method instead
|
|
34
|
*/
|
|
35
|
@Deprecated
|
|
36
|
public LanguageString add(LanguageString languageString);
|
|
37
|
/**
|
|
38
|
* Iterates on the languages. As soon as there exists a language string for this language in
|
|
39
|
* this multilanguage text
|
|
40
|
* it is returned.
|
|
41
|
* @param languages
|
|
42
|
* @return
|
|
43
|
*/
|
|
44
|
public LanguageString getPreferredLanguageString(List<Language> languages);
|
|
45
|
|
|
46
|
}
|