cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/INomenclaturalReference.java

   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
  10 package eu.etaxonomy.cdm.model.reference;
  11
  12 import eu.etaxonomy.cdm.model.common.TimePeriod;
  13 import eu.etaxonomy.cdm.model.name.TaxonNameBase;
  14
  15
  16  /**
  17  * Interface providing methods for nomenclatural references.
  18  *
  19  * @author m.doering
  20  * @version 1.0
  21  * @created 08-Nov-2007 13:06:29
  22  */
  23 public interface INomenclaturalReference extends IReference{
  24
  25         public final String MICRO_REFERENCE_TOKEN = "@@MicroReference";
  26
  27         /**
  28          * Returns a formatted string containing the reference citation excluding
  29          * authors but including the details as used in a {@link TaxonNameBase taxon name}.
  30          */
  31         public String getNomenclaturalCitation(String  microReference);
  32
  33         /**
  34          * Returns a string representation for the year of publication / creation
  35          * of a reference.
  36          */
  37         public String getYear();
  38
  39         public void setDatePublished(TimePeriod datePublished);
  40 }