EDIT

// $Id$

* 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.

*/

import eu.etaxonomy.cdm.model.agent.Person;

import eu.etaxonomy.cdm.model.agent.Team;

import eu.etaxonomy.cdm.model.common.UuidAndTitleCache;

	/**

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

	 * 

	 * @param person the person

	 * @param pageSize The maximum number of memberships returned (can be null for all memberships)

	 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)

	 * @return a Pager containing InstitutionalMembership  instances

	 */

	public Pager<InstitutionalMembership> getInstitutionalMemberships(Person person, Integer pageSize, Integer pageNumber);

	/**

	 * Return a paged list of the members of a team

	 * 

	 * @param team the team

	 * @param pageSize The maximum number of members returned (can be null for all members)

	 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)

	 * @return a Pager containing Person  instances

	 */

	public Pager<Person> getMembers(Team team, Integer pageSize, Integer pageNumber);

	/**

	 * Return a paged list of the addresses of an agent

	 * 

	 * @param agent the agent

	 * @param pageSize The maximum number of addresses returned (can be null for all members)

	 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)

	 * @return a Pager containing Address  instances

	 */

	public Pager<Address> getAddresses(AgentBase agent, Integer pageSize, Integer pageNumber);

	/**

	 * Returns a Paged List of AgentBase instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)

	 * 

	 * @param clazz filter the results by class (or pass null to return all AgentBase instances)

	 * @param queryString

	 * @param pageSize The maximum number of agents returned (can be null for all matching agents)

	 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)

	 * @param orderHints

	 *            Supports path like <code>orderHints.propertyNames</code> which

	 *            include *-to-one properties like createdBy.username or

	 *            authorTeam.persistentTitleCache

	 * @param propertyPaths properties to be initialized

	 * @return a Pager Agent instances

	 * @see <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">Apache Lucene - Query Parser Syntax</a>

	 */

	public Pager<AgentBase> search(Class<? extends AgentBase> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);

	/**

	 * Returns a list of <code>UuidAndTitleCache</code> containing all <code>Person</code>s

	 * 

	 * @return a list of <code>UuidAndTitleCache</code> instances

	 */

	public List<UuidAndTitleCache<Person>> getPersonUuidAndNomenclaturalTitle();

	/**

	 * Returns a list of <code>UuidAndTitleCache</code> containing all <code>TeamOrPersonBase</code> obejcts

	 * with their respective nomenclaturalTitle instead of regular titleCache

	 * 

	 * @return a list of <code>UuidAndTitleCache</code> instances

	 */

	public List<UuidAndTitleCache<TeamOrPersonBase>> getTeamOrPersonBaseUuidAndNomenclaturalTitle();