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

   1 /**
   2 * Copyright (C) 2009 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.strategy.cache.reference.GenericDefaultCacheStrategy;
  13
  14 /**
  15  * This interface represents all references which cannot be clearly assigned to a
  16  * particular {@link StrictReferenceBase reference} subclass. Therefore attributes which are
  17  * characteristic for a unique reference subclass are not necessary here.
  18  * <P>
  19  * This class corresponds, according to the TDWG ontology, to the publication type
  20  * terms (from PublicationTypeTerm): <ul>
  21  * <li> "Generic"
  22  * <li> "Artwork"
  23  * <li> "AudiovisualMaterial"
  24  * <li> "ComputerProgram"
  25  * <li> "Determination"
  26  * <li> "Commentary"
  27  * <li> "SubReference"
  28  * </ul>
  29  */
  30 public interface IGeneric extends IPublicationBase, INomenclaturalReference, IVolumeReference{
  31
  32         /**
  33          * Returns the editor of this generic reference
  34          */
  35         public String getEditor();
  36
  37         /**
  38          * Sets the editor for this generic reference
  39          * @param editor
  40          */
  41         public void setEditor(String editor);
  42
  43         /**
  44          * Returns the series of this generic reference
  45          */
  46         public String getSeriesPart();
  47
  48         /**
  49          * Sets the series for this generic reference
  50          * @param series
  51          */
  52         public void setSeriesPart(String series);
  53
  54         /**
  55          * Returns the pages (page span this reference covers in its in-reference)
  56          */
  57         public String getPages();
  58
  59         /**
  60          * Sets the pages (page span this reference covers in its in-reference)
  61          * @param pages
  62          */
  63         public void setPages(String pages);
  64
  65         /**
  66          * Returns the inreference of this generic reference
  67          */
  68         public IGeneric getInReference();
  69
  70         /**
  71          * Sets the inreference.
  72          * @param inReference
  73          */
  74         public void setInReference(Reference inReference);
  75
  76         void setCacheStrategy(GenericDefaultCacheStrategy cacheStratefy);
  77
  78 }