add javadoc to remoteLoad

diff --git a/eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/taxeditor/session/CdmEntitySession.java b/eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/taxeditor/session/CdmEntitySession.java
index 01ed0d44f0d7767f0cae0074a32ad1c67030c70e..459c3dd137fdbdb73d7c2803bd49fcadf22ef385 100644 (file)
--- a/eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/taxeditor/session/CdmEntitySession.java
+++ b/eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/taxeditor/session/CdmEntitySession.java
@@ -23,6 +23,7 @@ import eu.etaxonomy.cdm.cache.CdmTransientEntityCacher;
 //import eu.etaxonomy.taxeditor.remoting.cache.CdmTransientEntityCacher;
 import eu.etaxonomy.cdm.cache.EntityCacherDebugResult;
 import eu.etaxonomy.cdm.model.common.CdmBase;
+import eu.etaxonomy.cdm.persistence.dao.initializer.IBeanInitializer;
 import eu.etaxonomy.cdm.persistence.dto.MergeResult;
 import eu.etaxonomy.taxeditor.remoting.cache.ConversationalTransientEntityCacher;
 import net.sf.ehcache.statistics.LiveCacheStatistics;
@@ -222,8 +223,15 @@ public class CdmEntitySession implements ICdmEntitySession  {
 //    }
 
 
-    /* (non-Javadoc)
-     * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#load(java.util.UUID, java.lang.Class)
+    /**
+     *  Returns a persisted entity specified by the <code>uuid</code>
+     *  or null if the entity does not exist,
+     *  loads it to the entityCacher
+     *
+     * @param service
+     * @param uuid
+     *
+     * @return
      */
     @Override
     public  <T extends CdmBase>  T remoteLoad(IService<T> service, UUID uuid) {
@@ -232,8 +240,20 @@ public class CdmEntitySession implements ICdmEntitySession  {
     }
 
 
-    /* (non-Javadoc)
-     * @see eu.etaxonomy.taxeditor.session.ICdmEntitySession#load(eu.etaxonomy.cdm.api.service.IService, java.util.UUID, java.util.List)
+    /**
+     * Returns the cdm entity specified by the <code>uuid</code>,
+     * recursively initializes all bean properties given in the
+     * <code>propertyPaths</code> parameter,
+     * the loaded entity is also loaded to the entityCache
+     * <p>
+     * For detailed description and examples <b>please refer to:</b>
+     * {@link IBeanInitializer#initialize(Object, List)}
+     *
+     * @param service
+     * @param uuid
+     * @param propertyPath
+     *
+     * @return
      */
     @Override
     public <T extends CdmBase>  T remoteLoad(IService<T> service, UUID uuid, List<String> propertyPaths) {