eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/annotatedlineeditor/IEntityContainer.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 package eu.etaxonomy.taxeditor.annotatedlineeditor;
  10
  11 import java.util.Set;
  12
  13 /**
  14  * <p>IEntityContainer interface.</p>
  15  *
  16  * @author p.ciardelli
  17  * @created 25.06.2009
  18  * @version 1.0
  19  * @param <T>
  20  */
  21 public interface IEntityContainer<T> {
  22
  23         /**
  24          * <p>getEntity</p>
  25          *
  26          * @param <T> a T object.
  27          * @return a T object.
  28          */
  29         T getEntity();
  30
  31         void setEntity(Object entity);
  32
  33         /**
  34          * <p>getEditableText</p>
  35          *
  36          * @return a {@link java.lang.String} object.
  37          */
  38         String getEditableText();
  39
  40         /**
  41          * <p>getAttachedEntities</p>
  42          *
  43          * @return a {@link java.util.Set} object.
  44          */
  45         Set<T> getAttachedEntities();
  46
  47         /**
  48          * <p>markAsMerged</p>
  49          *
  50          * @param mergeTarget a T object.
  51          */
  52         void markAsMerged(T mergeTarget);
  53
  54         /**
  55          * <p>markAsDeleted</p>
  56          */
  57         void markAsDeleted();
  58
  59         /**
  60          * <p>markAsNew</p>
  61          *
  62          * @param isNew a boolean.
  63          */
  64         void markAsNew(boolean isNew);
  65
  66         /**
  67          * <p>isMarkedAsMerged</p>
  68          *
  69          * @return a boolean.
  70          */
  71         boolean isMarkedAsMerged();
  72
  73         /**
  74          * <p>isMarkedAsDeleted</p>
  75          *
  76          * @return a boolean.
  77          */
  78         boolean isMarkedAsDeleted();
  79
  80         /**
  81          * <p>isMarkedAsNew</p>
  82          *
  83          * @return a boolean.
  84          */
  85         boolean isMarkedAsNew();
  86
  87         /**
  88          * <p>setText</p>
  89          *
  90          * @param text a {@link java.lang.String} object.
  91          */
  92         void setText(String text);
  93
  94         /**
  95          * <p>getMergeTarget</p>
  96          *
  97          * @return a T object.
  98          */
  99         T getMergeTarget();
 100
 101         /**
 102          * <p>isDirty</p>
 103          *
 104          * @return a boolean.
 105          */
 106         boolean isDirty();
 107
 108         /**
 109          * <p>setDirty</p>
 110          *
 111          * @param dirty a boolean.
 112          */
 113         void setDirty(boolean dirty);
 114 }