- added service method to get descriptions which have a specimen set as describedSpe...

[cdmlib.git] / cdmlib-services / src / main / java / eu / etaxonomy / cdm / api / service / IAgentService.java

diff --git a/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IAgentService.java b/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IAgentService.java
index 735e4f78a466f12d4f12f39ffdcc3182669c4904..dba4504c0855ff7742e14e97b5b753652a923ffa 100644 (file)
--- a/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IAgentService.java
+++ b/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IAgentService.java
@@ -1,3 +1,4 @@
+// $Id$\r

 /**\r
 * Copyright (C) 2007 EDIT\r
 * European Distributed Institute of Taxonomy \r
 /**\r
 * Copyright (C) 2007 EDIT\r
 * European Distributed Institute of Taxonomy \r


@@ -9,36 +10,21 @@
 \r
 package eu.etaxonomy.cdm.api.service;\r
 \r
 \r
 package eu.etaxonomy.cdm.api.service;\r
 \r

-import java.util.Collection;\r

 import java.util.List;\r
 import java.util.List;\r

-import java.util.Map;\r
-import java.util.UUID;\r

 \r
 import eu.etaxonomy.cdm.api.service.pager.Pager;\r
 \r
 import eu.etaxonomy.cdm.api.service.pager.Pager;\r

-import eu.etaxonomy.cdm.model.agent.Agent;\r
+import eu.etaxonomy.cdm.model.agent.Address;\r
+import eu.etaxonomy.cdm.model.agent.AgentBase;\r

 import eu.etaxonomy.cdm.model.agent.Institution;\r
 import eu.etaxonomy.cdm.model.agent.InstitutionalMembership;\r
 import eu.etaxonomy.cdm.model.agent.Person;\r
 import eu.etaxonomy.cdm.model.agent.Team;\r
 import eu.etaxonomy.cdm.model.agent.Institution;\r
 import eu.etaxonomy.cdm.model.agent.InstitutionalMembership;\r
 import eu.etaxonomy.cdm.model.agent.Person;\r
 import eu.etaxonomy.cdm.model.agent.Team;\r

+import eu.etaxonomy.cdm.model.common.UuidAndTitleCache;\r
+import eu.etaxonomy.cdm.persistence.query.OrderHint;\r

 \r
 \r

-public interface IAgentService extends IIdentifiableEntityService<Agent> {\r
-       \r
-       // FIXME Candidate for harmonization\r
-       public abstract Agent getAgentByUuid(UUID uuid);\r
-\r
-       // FIXME Candidate for harmonization\r
-       public abstract UUID saveAgent(Agent agent);\r
-       \r
-       // FIXME Candidate for harmonization\r
-       public abstract Map<UUID, Agent> saveAgentAll(Collection<Agent> agentCollection);\r
-       \r
-       // FIXME Candidate for harmonization\r
-       public abstract List<Agent> findAgentsByTitle(String title);\r
-\r
-       // FIXME Candidate for harmonization\r
-       public abstract List<? extends Agent> getAllAgents(int limit, int start);\r
-       \r
-       public abstract List<Institution> searchInstitutionByCode(String code);\r
+public interface IAgentService extends IIdentifiableEntityService<AgentBase> {\r
+               \r
+       public List<Institution> searchInstitutionByCode(String code);\r

        \r
        /**\r
         * Return a paged list of the institutional memberships held by a person\r
        \r
        /**\r
         * Return a paged list of the institutional memberships held by a person\r


@@ -59,4 +45,63 @@ public interface IAgentService extends IIdentifiableEntityService<Agent> {
         * @return a Pager containing Person  instances\r
         */\r
        public Pager<Person> getMembers(Team team, Integer pageSize, Integer pageNumber);\r
         * @return a Pager containing Person  instances\r
         */\r
        public Pager<Person> getMembers(Team team, Integer pageSize, Integer pageNumber);\r

+       \r
+       /**\r
+        * Return a paged list of the addresses of an agent\r
+        * \r
+        * @param agent the agent\r
+        * @param pageSize The maximum number of addresses returned (can be null for all members)\r
+        * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)\r
+        * @return a Pager containing Address  instances\r
+        */\r
+       public Pager<Address> getAddresses(AgentBase agent, Integer pageSize, Integer pageNumber);\r
+       \r
+       /**\r
+        * Returns a Paged List of AgentBase instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)\r
+        * \r
+        * @param clazz filter the results by class (or pass null to return all AgentBase instances)\r
+        * @param queryString\r
+        * @param pageSize The maximum number of agents returned (can be null for all matching agents)\r
+        * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)\r
+        * @param orderHints\r
+        *            Supports path like <code>orderHints.propertyNames</code> which\r
+        *            include *-to-one properties like createdBy.username or\r
+        *            authorTeam.persistentTitleCache\r
+        * @param propertyPaths properties to be initialized\r
+        * @return a Pager Agent instances\r
+        * @see <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">Apache Lucene - Query Parser Syntax</a>\r
+        */\r
+       public Pager<AgentBase> search(Class<? extends AgentBase> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);\r
+       \r
+       /**\r
+        * Returns a list of <code>UuidAndTitleCache</code> containing all <code>Person</code>s\r
+        * \r
+        * @return a list of <code>UuidAndTitleCache</code> instances\r
+        */\r
+       public List<UuidAndTitleCache<Person>> getPersonUuidAndTitleCache();\r
+       \r
+       /**\r
+        * Returns a list of <code>UuidAndTitleCache</code> containing all <code>TeamOrPersonBase</code> objects\r
+        * with their respective titleCache\r
+        * \r
+        * @return a list of <code>UuidAndTitleCache</code> instances\r
+        */\r
+       public List<UuidAndTitleCache<Team>> getTeamUuidAndTitleCache();\r
+       \r
+       /**\r
+        * Returns a list of <code>UuidAndTitleCache</code> containing all <code>TeamOrPersonBase</code> objects\r
+        * with their respective nomenclaturalTitle instead of regular titleCache\r
+        * \r
+        * @return a list of <code>UuidAndTitleCache</code> instances\r
+        */\r
+       public List<UuidAndTitleCache<Team>> getTeamUuidAndNomenclaturalTitle();\r
+       \r
+       /**\r
+        * Returns a list of <code>UuidAndTitleCache</code> containing all {@link Institution} objects\r
+        * with their respective titleCache\r
+        * \r
+        * @return a list of <code>UuidAndTitleCache</code> instances\r
+        */\r
+       public List<UuidAndTitleCache<Institution>> getInstitutionUuidAndTitleCache();\r
+       \r

 }\r
 }\r