Project

General

Profile

Download (1.37 KB) Statistics
| Branch: | Tag: | Revision:
1 9479da48 Andreas Müller
/**
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
10
package eu.etaxonomy.cdm.model.reference;
11
12 dc776ce0 a.babadshanjan
import eu.etaxonomy.cdm.model.common.IIdentifiableEntity;
13 6680df00 Andreas Müller
import eu.etaxonomy.cdm.model.common.IParsable;
14 99dac0aa Andreas Müller
import eu.etaxonomy.cdm.model.common.TimePeriod;
15 788ff862 Andreas Müller
16 9479da48 Andreas Müller
17 f6ee8929 m.geoffroy
 /**
18
 * Interface providing methods for nomenclatural references. 
19
 * 
20 9479da48 Andreas Müller
 * @author m.doering
21
 * @version 1.0
22
 * @created 08-Nov-2007 13:06:29
23
 */
24 f6765014 ben.clark
public interface INomenclaturalReference extends IIdentifiableEntity, IParsable{
25 9479da48 Andreas Müller
26 bef42c31 Andreas Müller
	public final String MICRO_REFERENCE_TOKEN = "@@MicroReference";
27
	
28 9479da48 Andreas Müller
	/**
29 677fa923 m.geoffroy
	 * Returns a formatted string containing the reference citation excluding
30 5fea4b1e m.geoffroy
	 * authors but including the details as used in a {@link TaxonNameBase taxon name}.
31 9479da48 Andreas Müller
	 */
32 bef42c31 Andreas Müller
	public String getNomenclaturalCitation(String  microReference);
33 9479da48 Andreas Müller
34 ef1e62cf m.geoffroy
	/**
35
	 * Returns a string representation for the year of publication / creation
36
	 * of a reference.
37
	 */
38 9479da48 Andreas Müller
	public String getYear();
39
40 ef1e62cf m.geoffroy
	/**
41
	 * Returns the boolean value indicating whether the used parser 
42
	 * method was able to parse the string designating the reference
43
	 * successfully (false) or not (true).
44
	 */
45 0d885ec1 Andreas Müller
	public boolean getHasProblem();
46
	
47 99dac0aa Andreas Müller
	public void setDatePublished(TimePeriod datePublished);
48
	
49
	
50 9479da48 Andreas Müller
}