cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/ISectionBase.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 /**
  13  * This  interface represents isolated sections (parts, chapters or
  14  * papers) within a {@link IPrintedUnitBase printed unit}.
  15  * <P>
  16  * This class corresponds, according to the TDWG ontology, to the publication type
  17  * term (from PublicationTypeTerm): "SubReference".
  18  */
  19 public interface ISectionBase extends IReference {
  20
  21         /**
  22          * Returns the pages this reference covers in its in-reference.
  23          * E.g. if this reference is an article it may cover the pages
  24          * 34-45 in the according journal.
  25          */
  26         public String getPages();
  27
  28         /**
  29          * Sets the pages that this reference covers in its in-reference
  30          * @see #getPages()
  31          * @param pages
  32          */
  33         public void setPages(String pages);
  34
  35         /**
  36          * Returns the in-reference of this reference.
  37          * E.g. if this reference is a book section the according book is returned
  38          */
  39         public Reference getInReference();
  40
  41         /**
  42          * Sets the in-reference of this reference.
  43          * E.g. if this reference is a book section the according book is set via this
  44          * method.
  45          */
  46         public void setInReference(Reference reference);
  47 }