Committing large number of changes relating to versioning implementation (#108)

[cdmlib.git] / cdmlib-persistence / src / main / java / eu / etaxonomy / cdm / persistence / dao / common / IIdentifiableDao.java

diff --git a/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/common/IIdentifiableDao.java b/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/common/IIdentifiableDao.java
index a8b593348ea369a002f61f584cfbc9d78830d1f0..495d5a28ce9b19dbbacec2b7d5b144114b62f0e9 100644 (file)
--- a/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/common/IIdentifiableDao.java
+++ b/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/common/IIdentifiableDao.java
@@ -1,7 +1,74 @@
+/**
+* Copyright (C) 2007 EDIT
+* European Distributed Institute of Taxonomy 
+* http://www.e-taxonomy.eu
+* 
+* The contents of this file are subject to the Mozilla Public License Version 1.1
+* See LICENSE.TXT at the top of this package for the full license terms.
+*/
+
 package eu.etaxonomy.cdm.persistence.dao.common;
 
+import java.util.List;
+
 import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
+import eu.etaxonomy.cdm.model.common.LSID;
+import eu.etaxonomy.cdm.model.common.OriginalSource;
+import eu.etaxonomy.cdm.model.media.Rights;
 
-public interface IIdentifiableDao <T extends IdentifiableEntity> extends ICdmEntityDao<T>, ITitledDao<T>{
+public interface IIdentifiableDao <T extends IdentifiableEntity> extends IAnnotatableDao<T>, ITitledDao<T>{
+       
+       /**
+        * Return an object by LSID. NOTE: Because of the fact that LSIDs are supposed to
+        * be globally resolvable, this method behaves in a different way to other methods
+        * 
+        * In short, it attempts to find an object of type T in the current view using the LSID passed. If the LSID passed has a 
+        * revision part, then this will be used in the query, but if not, then it is expected that the request is for the 'current'
+        * version of the object and the revision part will not be used as a matching criteria in the query. 
+        * 
+        * If the object does not appear in the current view (i.e. it has been deleted), then this method will search the history 
+        * tables for a match, again using the revision if it exists, but ignoring it if not.
+        * 
+        *  @param lsid a LifeScience Identifier identifying the desired object
+        */
+       public T find(LSID lsid);
+       
+       /**
+        * Return a count of the sources for this identifiable entity
+        * 
+        * @param identifiableEntity The identifiable entity
+        * @return a count of OriginalSource instances
+        */
+       public int countSources(T identifiableEntity);
+       
+       /**
+        * Return a List of the sources for this identifiable entity
+        * 
+        * @param identifiableEntity The identifiable entity
+        * @param pageSize The maximum number of sources returned (can be null for all sources)
+        * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
+        * @return a List of OriginalSource instances
+        */
+       public List<OriginalSource> getSources(T identifiableEntity, Integer pageSize, Integer pageNumber);
+       
+       /**
+        * Return a count of the rights for this identifiable entity
+        * 
+        * @param identifiableEntity The identifiable entity
+        * @return a count of Rights instances
+        */
+    public int countRights(T identifiableEntity);
+       
+       /**
+        * Return a List of the rights for this identifiable entity
+        * 
+        * @param identifiableEntity The identifiable entity
+        * @param pageSize The maximum number of rights returned (can be null for all rights)
+        * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
+        * @return a List of Rights instances
+        */
+       public List<Rights> getRights(T identifiableEntity, Integer pageSize, Integer pageNumber);
        
+       // TODO Migrated from IOriginalSourceDao
+       public List<T> findOriginalSourceByIdInSource(String idInSource, String idNamespace);
 }