DS-4166 community feedback: renamed FindableObjectService in IndexableObjectService

dspace-api/src/main/java/org/dspace/content/CollectionServiceImpl.java

@@ -275,6 +275,15 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl<Collection> i
         return collectionDAO.findByID(context, Collection.class, id);
     }
 
+    @Override
+    /**
+     * This method is an alias of the find method needed to avoid ambiguity between the IndexableObjectService interface
+     * and the DSpaceObjectService interface
+     */
+    public Collection findIndexableObject(Context context, UUID id) throws SQLException {
+        return collectionDAO.findByID(context, Collection.class, id);
+    }
+
     @Override
     public void setMetadata(Context context, Collection collection, String field, String value)
         throws MissingResourceException, SQLException {
@@ -781,6 +790,15 @@ public class CollectionServiceImpl extends DSpaceObjectServiceImpl<Collection> i
         return Constants.COLLECTION;
     }
 
+    @Override
+    /**
+     * This method is an alias of the getSupportsTypeConstant method needed to avoid ambiguity between the
+     * IndexableObjectService interface and the DSpaceObjectService interface
+     */
+    public int getSupportsIndexableObjectTypeConstant() {
+        return getSupportsTypeConstant();
+    }
+
     @Override
     public List<Collection> findAuthorized(Context context, Community community, int actionID) throws SQLException {
         List<Collection> myResults = new ArrayList<>();

dspace-api/src/main/java/org/dspace/content/CommunityServiceImpl.java

@@ -137,6 +137,15 @@ public class CommunityServiceImpl extends DSpaceObjectServiceImpl<Community> imp
         return communityDAO.findByID(context, Community.class, id);
     }
 
+    @Override
+    /**
+     * This method is an alias of the find method needed to avoid ambiguity between the IndexableObjectService interface
+     * and the DSpaceObjectService interface
+     */
+    public Community findIndexableObject(Context context, UUID id) throws SQLException {
+        return find(context, id);
+    }
+
     @Override
     public List<Community> findAll(Context context) throws SQLException {
         MetadataField sortField = metadataFieldService.findByElement(context, MetadataSchema.DC_SCHEMA, "title", null);
@@ -508,6 +517,14 @@ public class CommunityServiceImpl extends DSpaceObjectServiceImpl<Community> imp
         return Constants.COMMUNITY;
     }
 
+    @Override
+    /**
+     * This method is an alias of the getSupportsTypeConstant method needed to avoid ambiguity between the
+     * IndexableObjectService interface and the DSpaceObjectService interface
+     */
+    public int getSupportsIndexableObjectTypeConstant() {
+        return getSupportsTypeConstant();
+    }
 
     /**
      * Internal method to remove the community and all its children from the

dspace-api/src/main/java/org/dspace/content/ItemServiceImpl.java

@@ -158,6 +158,15 @@ public class ItemServiceImpl extends DSpaceObjectServiceImpl<Item> implements It
         return item;
     }
 
+    @Override
+    /**
+     * This method is an alias of the find method needed to avoid ambiguity between the IndexableObjectService interface
+     * and the DSpaceObjectService interface
+     */
+    public Item findIndexableObject(Context context, UUID id) throws SQLException {
+        return find(context, id);
+    }
+
     @Override
     public Item create(Context context, WorkspaceItem workspaceItem) throws SQLException, AuthorizeException {
         if (workspaceItem.getItem() != null) {
@@ -644,6 +653,15 @@ public class ItemServiceImpl extends DSpaceObjectServiceImpl<Item> implements It
         return Constants.ITEM;
     }
 
+    @Override
+    /**
+     * This method is an alias of the getSupportsTypeConstant method needed to avoid ambiguity between the
+     * IndexableObjectService interface and the DSpaceObjectService interface
+     */
+    public int getSupportsIndexableObjectTypeConstant() {
+        return getSupportsTypeConstant();
+    }
+
     protected void rawDelete(Context context, Item item) throws AuthorizeException, SQLException, IOException {
         authorizeService.authorizeAction(context, item, Constants.REMOVE);
 

dspace-api/src/main/java/org/dspace/content/WorkspaceItemServiceImpl.java

@@ -61,12 +61,12 @@ public class WorkspaceItemServiceImpl implements WorkspaceItemService {
     }
 
     @Override
-    public int getSupportsTypeConstant() {
+    public int getSupportsIndexableObjectTypeConstant() {
         return Constants.WORKSPACEITEM;
     }
 
     @Override
-    public WorkspaceItem find(Context context, Integer id) throws SQLException {
+    public WorkspaceItem find(Context context, int id) throws SQLException {
         WorkspaceItem workspaceItem = workspaceItemDAO.findByID(context, WorkspaceItem.class, id);
 
         if (workspaceItem == null) {
@@ -83,6 +83,14 @@ public class WorkspaceItemServiceImpl implements WorkspaceItemService {
         return workspaceItem;
     }
 
+    @Override
+    public WorkspaceItem findIndexableObject(Context context, Integer id) throws SQLException {
+        if (id != null) {
+            return find(context, id);
+        }
+        return null;
+    }
+
     @Override
     public WorkspaceItem create(Context context, Collection collection, boolean template)
         throws AuthorizeException, SQLException {

dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactory.java

@@ -20,8 +20,8 @@ import org.dspace.content.service.CollectionService;
 import org.dspace.content.service.CommunityService;
 import org.dspace.content.service.DSpaceObjectLegacySupportService;
 import org.dspace.content.service.DSpaceObjectService;
-import org.dspace.content.service.FindableObjectService;
 import org.dspace.content.service.InProgressSubmissionService;
+import org.dspace.content.service.IndexableObjectService;
 import org.dspace.content.service.InstallItemService;
 import org.dspace.content.service.ItemService;
 import org.dspace.content.service.MetadataFieldService;
@@ -43,11 +43,11 @@ import org.dspace.workflow.factory.WorkflowServiceFactory;
 public abstract class ContentServiceFactory {
 
     /**
-     * Return the list of all the available implementation of the FindableObjectService interface
+     * Return the list of all the available implementations of the IndexableObjectService interface
      * 
-     * @return the list of FindableObjectService
+     * @return the list of IndexableObjectService
      */
-    public abstract List<FindableObjectService> getFindableObjectServices();
+    public abstract List<IndexableObjectService> getIndexableObjectServices();
 
     public abstract List<DSpaceObjectService<? extends DSpaceObject>> getDSpaceObjectServices();
 
@@ -108,12 +108,12 @@ public abstract class ContentServiceFactory {
     }
 
     @SuppressWarnings("unchecked")
-    public <T extends IndexableObject<PK>, PK extends Serializable> FindableObjectService<T, PK>
+    public <T extends IndexableObject<PK>, PK extends Serializable> IndexableObjectService<T, PK>
-        getFindableObjectService(int type) {
+        getIndexableObjectService(int type) {
-        for (int i = 0; i < getFindableObjectServices().size(); i++) {
+        for (int i = 0; i < getIndexableObjectServices().size(); i++) {
-            FindableObjectService objectService = getFindableObjectServices().get(i);
+            IndexableObjectService objectService = getIndexableObjectServices().get(i);
-            if (objectService.getSupportsTypeConstant() == type) {
+            if (objectService.getSupportsIndexableObjectTypeConstant() == type) {
-                return (FindableObjectService<T, PK>) objectService;
+                return (IndexableObjectService<T, PK>) objectService;
             }
         }
         throw new UnsupportedOperationException("Unknown Findable Object type: " + type);

dspace-api/src/main/java/org/dspace/content/factory/ContentServiceFactoryImpl.java

@@ -17,7 +17,7 @@ import org.dspace.content.service.CollectionService;
 import org.dspace.content.service.CommunityService;
 import org.dspace.content.service.DSpaceObjectLegacySupportService;
 import org.dspace.content.service.DSpaceObjectService;
-import org.dspace.content.service.FindableObjectService;
+import org.dspace.content.service.IndexableObjectService;
 import org.dspace.content.service.InstallItemService;
 import org.dspace.content.service.ItemService;
 import org.dspace.content.service.MetadataFieldService;
@@ -70,8 +70,8 @@ public class ContentServiceFactoryImpl extends ContentServiceFactory {
     private SiteService siteService;
 
     @Override
-    public List<FindableObjectService> getFindableObjectServices() {
+    public List<IndexableObjectService> getIndexableObjectServices() {
-        return new DSpace().getServiceManager().getServicesByType(FindableObjectService.class);
+        return new DSpace().getServiceManager().getServicesByType(IndexableObjectService.class);
     }
 
     @Override

dspace-api/src/main/java/org/dspace/content/service/CollectionService.java

@@ -13,6 +13,7 @@ import java.sql.SQLException;
 import java.util.List;
 import java.util.Map;
 import java.util.MissingResourceException;
+import java.util.UUID;
 
 import org.dspace.authorize.AuthorizeException;
 import org.dspace.content.Bitstream;
@@ -30,7 +31,8 @@ import org.dspace.eperson.Group;
  * @author kevinvandevelde at atmire.com
  */
 public interface CollectionService
-    extends DSpaceObjectService<Collection>, DSpaceObjectLegacySupportService<Collection> {
+        extends DSpaceObjectService<Collection>, DSpaceObjectLegacySupportService<Collection>,
+        IndexableObjectService<Collection, UUID> {
 
     /**
      * Create a new collection with a new ID.

dspace-api/src/main/java/org/dspace/content/service/CommunityService.java

@@ -12,6 +12,7 @@ import java.io.InputStream;
 import java.sql.SQLException;
 import java.util.List;
 import java.util.MissingResourceException;
+import java.util.UUID;
 
 import org.dspace.authorize.AuthorizeException;
 import org.dspace.content.Bitstream;
@@ -27,7 +28,8 @@ import org.dspace.eperson.Group;
  *
  * @author kevinvandevelde at atmire.com
  */
-public interface CommunityService extends DSpaceObjectService<Community>, DSpaceObjectLegacySupportService<Community> {
+public interface CommunityService extends DSpaceObjectService<Community>, DSpaceObjectLegacySupportService<Community>,
+        IndexableObjectService<Community, UUID> {
 
 
     /**

dspace-api/src/main/java/org/dspace/content/service/DSpaceObjectService.java

@@ -28,7 +28,17 @@ import org.dspace.core.Context;
  * @param <T> class type
  * @author kevinvandevelde at atmire.com
  */
-public interface DSpaceObjectService<T extends DSpaceObject> extends FindableObjectService<T, UUID> {
+public interface DSpaceObjectService<T extends DSpaceObject> {
+
+    /**
+     * Generic find for when the precise type of an Entity is not known
+     *
+     * @param context - the context
+     * @param uuid      - uuid within table of type'd dspace objects
+     * @return the dspace object found, or null if it does not exist.
+     * @throws SQLException only upon failure accessing the database.
+     */
+    public T find(Context context, UUID uuid) throws SQLException;
 
     /**
      * Get a proper name for the object. This may return <code>null</code>.
@@ -369,4 +379,11 @@ public interface DSpaceObjectService<T extends DSpaceObject> extends FindableObj
 
     void moveMetadata(Context context, T dso, String schema, String element, String qualifier, int from, int to)
         throws SQLException;
+
+    /**
+     * Returns the Constants which this service supports
+     *
+     * @return a org.dspace.core.Constants that represents a IndexableObject type
+     */
+    public int getSupportsTypeConstant();
 }

dspace-api/src/main/java/org/dspace/content/service/FindableObjectService.java

@@ -1,41 +0,0 @@
-/**
- * The contents of this file are subject to the license and copyright
- * detailed in the LICENSE and NOTICE files at the root of the source
- * tree and available online at
- *
- * http://www.dspace.org/license/
- */
-package org.dspace.content.service;
-
-import java.io.Serializable;
-import java.sql.SQLException;
-
-import org.dspace.core.Context;
-
-/**
- * Base Service interface class for any Persistent Entity findable by a primary key.
- *
- * @param <T> class type of the persistent entity
- * @param <PK> class type of the primary key
- * @author Andrea Bollini (andrea.bollini at 4science.it)
- */
-public interface FindableObjectService<T, PK extends Serializable> {
-
-
-    /**
-     * Generic find for when the precise type of an Entity is not known
-     *
-     * @param context - the context
-     * @param id      - id within table of type'd objects
-     * @return the object found, or null if it does not exist.
-     * @throws SQLException only upon failure accessing the database.
-     */
-    public T find(Context context, PK id) throws SQLException;
-
-    /**
-     * Returns the Constants which this service supports
-     *
-     * @return a org.dspace.core.Constants that represents a IndexableObject type
-     */
-    public int getSupportsTypeConstant();
-}

dspace-api/src/main/java/org/dspace/content/service/InProgressSubmissionService.java

@@ -26,7 +26,7 @@ import org.dspace.core.Context;
  * @author kevinvandevelde at atmire.com
  */
 public interface InProgressSubmissionService<T extends InProgressSubmission<ID>, ID extends Serializable>
-    extends FindableObjectService<T, ID> {
+    extends IndexableObjectService<T, ID> {
 
     /**
      * Deletes submission wrapper, doesn't delete item contents

dspace-api/src/main/java/org/dspace/content/service/IndexableObjectService.java

@@ -0,0 +1,44 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.content.service;
+
+import java.io.Serializable;
+import java.sql.SQLException;
+
+import org.dspace.core.Context;
+import org.dspace.discovery.IndexableObject;
+
+/**
+ * Base Service interface class for any IndexableObject. The name of the methods contains IndexableObject to avoid
+ * ambiguity reference as some implementation supports both this interface than the DSpaceObectService interface
+ *
+ * @param <T>
+ *            class type of the indexable object
+ * @param <PK>
+ *            class type of the primary key
+ * @author Andrea Bollini (andrea.bollini at 4science.it)
+ */
+public interface IndexableObjectService<T extends IndexableObject<PK>, PK extends Serializable> {
+
+    /**
+     * Generic find for when the precise type of an IndexableObject is not known
+     *
+     * @param context - the context
+     * @param id      - id within table of type'd indexable objects
+     * @return the indexable object found, or null if it does not exist.
+     * @throws SQLException only upon failure accessing the database.
+     */
+    public T findIndexableObject(Context context, PK id) throws SQLException;
+
+    /**
+     * Returns the Constants which this service supports
+     *
+     * @return a org.dspace.core.Constants that represents a IndexableObject type
+     */
+    public int getSupportsIndexableObjectTypeConstant();
+}

dspace-api/src/main/java/org/dspace/content/service/ItemService.java

@@ -36,7 +36,8 @@ import org.dspace.eperson.Group;
  *
  * @author kevinvandevelde at atmire.com
  */
-public interface ItemService extends DSpaceObjectService<Item>, DSpaceObjectLegacySupportService<Item> {
+public interface ItemService
+        extends DSpaceObjectService<Item>, DSpaceObjectLegacySupportService<Item>, IndexableObjectService<Item, UUID> {
 
     public Thumbnail getThumbnail(Context context, Item item, boolean requireOriginal) throws SQLException;
 

dspace-api/src/main/java/org/dspace/content/service/WorkspaceItemService.java

@@ -29,6 +29,17 @@ import org.dspace.workflow.WorkflowItem;
  */
 public interface WorkspaceItemService extends InProgressSubmissionService<WorkspaceItem, Integer> {
 
+    /**
+     * Get a workspace item from the database. The item, collection and
+     * submitter are loaded into memory.
+     *
+     * @param context DSpace context object
+     * @param id      ID of the workspace item
+     * @return the workspace item, or null if the ID is invalid.
+     * @throws SQLException if database error
+     */
+    public WorkspaceItem find(Context context, int id) throws SQLException;
+
     /**
      * Create a new workspace item, with a new ID. An Item is also created. The
      * submitter is the current user in the context.

dspace-api/src/main/java/org/dspace/discovery/SolrServiceImpl.java

@@ -2237,7 +2237,8 @@ public class SolrServiceImpl implements SearchService, IndexingService {
         }
 
         if (uid != null) {
-            o = (IndexableObject) contentServiceFactory.getFindableObjectService(type).find(context, uid);
+            o = (IndexableObject) contentServiceFactory.getIndexableObjectService(type).findIndexableObject(context,
+                    uid);
         }
 
         if (o == null) {
@@ -2282,8 +2283,8 @@ public class SolrServiceImpl implements SearchService, IndexingService {
                 SolrDocument doc = (SolrDocument) iter.next();
 
                 IndexableObject o = (IndexableObject)contentServiceFactory
-                    .getFindableObjectService((Integer) doc.getFirstValue(RESOURCE_TYPE_FIELD))
+                    .getIndexableObjectService((Integer) doc.getFirstValue(RESOURCE_TYPE_FIELD))
-                    .find(context, UUID.fromString((String) doc.getFirstValue(RESOURCE_ID_FIELD)));
+                    .findIndexableObject(context, UUID.fromString((String) doc.getFirstValue(RESOURCE_ID_FIELD)));
 
                 if (o != null) {
                     result.add(o);

dspace-api/src/main/java/org/dspace/workflow/WorkflowItemService.java

@@ -30,6 +30,16 @@ public interface WorkflowItemService<T extends WorkflowItem> extends InProgressS
 
     public T create(Context context, Item item, Collection collection) throws SQLException, AuthorizeException;
 
+    /**
+     * Get a workflow item from the database.
+     *
+     * @param context The relevant DSpace Context.
+     * @param id      ID of the workflow item
+     * @return the workflow item, or null if the ID is invalid.
+     * @throws SQLException An exception that provides information on a database access error or other errors.
+     */
+    public T find(Context context, int id) throws SQLException;
+
     /**
      * return all workflowitems
      *

dspace-api/src/main/java/org/dspace/workflowbasic/BasicWorkflowItemServiceImpl.java

@@ -54,7 +54,7 @@ public class BasicWorkflowItemServiceImpl implements BasicWorkflowItemService {
     }
 
     @Override
-    public int getSupportsTypeConstant() {
+    public int getSupportsIndexableObjectTypeConstant() {
         return Constants.WORKFLOWITEM;
     }
 
@@ -73,7 +73,7 @@ public class BasicWorkflowItemServiceImpl implements BasicWorkflowItemService {
     }
 
     @Override
-    public BasicWorkflowItem find(Context context, Integer id) throws SQLException {
+    public BasicWorkflowItem find(Context context, int id) throws SQLException {
         BasicWorkflowItem workflowItem = workflowItemDAO.findByID(context, BasicWorkflowItem.class, id);
 
         if (workflowItem == null) {
@@ -90,6 +90,14 @@ public class BasicWorkflowItemServiceImpl implements BasicWorkflowItemService {
         return workflowItem;
     }
 
+    @Override
+    public BasicWorkflowItem findIndexableObject(Context context, Integer id) throws SQLException {
+        if (id != null) {
+            return find(context, id);
+        }
+        return null;
+    }
+
     @Override
     public List<BasicWorkflowItem> findAll(Context context) throws SQLException {
         return workflowItemDAO.findAll(context, BasicWorkflowItem.class);

dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/ClaimedTaskServiceImpl.java

@@ -38,7 +38,7 @@ public class ClaimedTaskServiceImpl implements ClaimedTaskService {
     }
 
     @Override
-    public int getSupportsTypeConstant() {
+    public int getSupportsIndexableObjectTypeConstant() {
         return Constants.CLAIMEDTASK;
     }
 
@@ -53,7 +53,7 @@ public class ClaimedTaskServiceImpl implements ClaimedTaskService {
     }
 
     @Override
-    public ClaimedTask find(Context context, Integer id) throws SQLException {
+    public ClaimedTask findIndexableObject(Context context, Integer id) throws SQLException {
         if (id == null) {
             return null;
         }

dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/PoolTaskServiceImpl.java

@@ -49,7 +49,7 @@ public class PoolTaskServiceImpl implements PoolTaskService {
     }
 
     @Override
-    public int getSupportsTypeConstant() {
+    public int getSupportsIndexableObjectTypeConstant() {
         return Constants.POOLTASK;
     }
 
@@ -142,7 +142,7 @@ public class PoolTaskServiceImpl implements PoolTaskService {
     }
 
     @Override
-    public PoolTask find(Context context, Integer id) throws SQLException {
+    public PoolTask findIndexableObject(Context context, Integer id) throws SQLException {
         if (id == null) {
             return null;
         }

dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/XmlWorkflowItemServiceImpl.java

@@ -64,7 +64,7 @@ public class XmlWorkflowItemServiceImpl implements XmlWorkflowItemService {
     }
 
     @Override
-    public int getSupportsTypeConstant() {
+    public int getSupportsIndexableObjectTypeConstant() {
         return Constants.WORKFLOWITEM;
     }
 
@@ -78,10 +78,9 @@ public class XmlWorkflowItemServiceImpl implements XmlWorkflowItemService {
     }
 
     @Override
-    public XmlWorkflowItem find(Context context, Integer id) throws SQLException {
+    public XmlWorkflowItem find(Context context, int id) throws SQLException {
         XmlWorkflowItem workflowItem = xmlWorkflowItemDAO.findByID(context, XmlWorkflowItem.class, id);
 
-
         if (workflowItem == null) {
             if (log.isDebugEnabled()) {
                 log.debug(LogManager.getHeader(context, "find_workflow_item",
@@ -96,6 +95,14 @@ public class XmlWorkflowItemServiceImpl implements XmlWorkflowItemService {
         return workflowItem;
     }
 
+    @Override
+    public XmlWorkflowItem findIndexableObject(Context context, Integer id) throws SQLException {
+        if (id != null) {
+            return find(context, id);
+        }
+        return null;
+    }
+
     @Override
     public List<XmlWorkflowItem> findAll(Context context) throws SQLException {
         return xmlWorkflowItemDAO.findAll(context, XmlWorkflowItem.class);

dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/service/ClaimedTaskService.java

@@ -11,7 +11,7 @@ import java.sql.SQLException;
 import java.util.List;
 
 import org.dspace.authorize.AuthorizeException;
-import org.dspace.content.service.FindableObjectService;
+import org.dspace.content.service.IndexableObjectService;
 import org.dspace.core.Context;
 import org.dspace.eperson.EPerson;
 import org.dspace.service.DSpaceCRUDService;
@@ -26,7 +26,7 @@ import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem;
  * @author kevinvandevelde at atmire.com
  */
 public interface ClaimedTaskService extends DSpaceCRUDService<ClaimedTask>,
-    FindableObjectService<ClaimedTask, Integer> {
+    IndexableObjectService<ClaimedTask, Integer> {
 
     public List<ClaimedTask> findByWorkflowItem(Context context, XmlWorkflowItem workflowItem) throws SQLException;
 

dspace-api/src/main/java/org/dspace/xmlworkflow/storedcomponents/service/PoolTaskService.java

@@ -12,7 +12,7 @@ import java.sql.SQLException;
 import java.util.List;
 
 import org.dspace.authorize.AuthorizeException;
-import org.dspace.content.service.FindableObjectService;
+import org.dspace.content.service.IndexableObjectService;
 import org.dspace.core.Context;
 import org.dspace.eperson.EPerson;
 import org.dspace.service.DSpaceCRUDService;
@@ -26,7 +26,7 @@ import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem;
  *
  * @author kevinvandevelde at atmire.com
  */
-public interface PoolTaskService extends DSpaceCRUDService<PoolTask>, FindableObjectService<PoolTask, Integer> {
+public interface PoolTaskService extends DSpaceCRUDService<PoolTask>, IndexableObjectService<PoolTask, Integer> {
     public List<PoolTask> findByEperson(Context context, EPerson ePerson)
         throws SQLException, AuthorizeException, IOException;