eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/annotatedlineeditor/IEntityContainer.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   7 * The contents of this file are subject to the Mozilla Public License Version 1.1
   8 * See LICENSE.TXT at the top of this package for the full license terms.
   9 */
  10 package eu.etaxonomy.taxeditor.annotatedlineeditor;
  11
  12 import java.util.Set;
  13
  14 /**
  15  * <p>IEntityContainer interface.</p>
  16  *
  17  * @author p.ciardelli
  18  * @created 25.06.2009
  19  * @version 1.0
  20  * @param <T>
  21  */
  22 public interface IEntityContainer<T> {
  23
  24         /**
  25          * <p>getEntity</p>
  26          *
  27          * @param <T> a T object.
  28          * @return a T object.
  29          */
  30         T getEntity();
  31
  32         /**
  33          * <p>getEditableText</p>
  34          *
  35          * @return a {@link java.lang.String} object.
  36          */
  37         String getEditableText();
  38
  39         /**
  40          * <p>getAttachedEntities</p>
  41          *
  42          * @return a {@link java.util.Set} object.
  43          */
  44         Set<T> getAttachedEntities();
  45
  46         /**
  47          * <p>markAsMerged</p>
  48          *
  49          * @param mergeTarget a T object.
  50          */
  51         void markAsMerged(T mergeTarget);
  52
  53         /**
  54          * <p>markAsDeleted</p>
  55          */
  56         void markAsDeleted();
  57
  58         /**
  59          * <p>markAsNew</p>
  60          *
  61          * @param isNew a boolean.
  62          */
  63         void markAsNew(boolean isNew);
  64
  65         /**
  66          * <p>isMarkedAsMerged</p>
  67          *
  68          * @return a boolean.
  69          */
  70         boolean isMarkedAsMerged();
  71
  72         /**
  73          * <p>isMarkedAsDeleted</p>
  74          *
  75          * @return a boolean.
  76          */
  77         boolean isMarkedAsDeleted();
  78
  79         /**
  80          * <p>isMarkedAsNew</p>
  81          *
  82          * @return a boolean.
  83          */
  84         boolean isMarkedAsNew();
  85
  86         /**
  87          * <p>setText</p>
  88          *
  89          * @param text a {@link java.lang.String} object.
  90          */
  91         void setText(String text);
  92
  93         /**
  94          * <p>getMergeTarget</p>
  95          *
  96          * @return a T object.
  97          */
  98         T getMergeTarget();
  99
 100         /**
 101          * <p>isDirty</p>
 102          *
 103          * @return a boolean.
 104          */
 105         boolean isDirty();
 106
 107         /**
 108          * <p>setDirty</p>
 109          *
 110          * @param dirty a boolean.
 111          */
 112         void setDirty(boolean dirty);
 113 }