/*
 * LinShare is an open source filesharing software, part of the LinPKI software
 * suite, developed by Linagora.
 * 
 * Copyright (C) 2015 LINAGORA
 * 
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version, provided you comply with the Additional Terms applicable for
 * LinShare software by Linagora pursuant to Section 7 of the GNU Affero General
 * Public License, subsections (b), (c), and (e), pursuant to which you must
 * notably (i) retain the display of the “LinShare™” trademark/logo at the top
 * of the interface window, the display of the “You are using the Open Source
 * and free version of LinShare™, powered by Linagora © 2009–2015. Contribute to
 * Linshare R&D by subscribing to an Enterprise offer!” infobox and in the
 * e-mails sent with the Program, (ii) retain all hypertext links between
 * LinShare and linshare.org, between linagora.com and Linagora, and (iii)
 * refrain from infringing Linagora intellectual property rights over its
 * trademarks and commercial brands. Other Additional Terms apply, see
 * <http://www.linagora.com/licenses/> for more details.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Affero General Public License and
 * its applicable Additional Terms for LinShare along with this program. If not,
 * see <http://www.gnu.org/licenses/> for the GNU Affero General Public License
 * version 3 and <http://www.linagora.com/licenses/> for the Additional Terms
 * applicable to LinShare software.
 */
package org.linagora.linshare.core.repository;

import java.util.List;

import org.linagora.linshare.core.domain.entities.AllowedContact;
import org.linagora.linshare.core.domain.entities.Guest;
import org.linagora.linshare.core.domain.entities.User;
import org.linagora.linshare.core.exception.BusinessException;

/**
 * Some guest can only see a restricted list of users : the guest allowed contacts.
 * 
 * @author sduprey
 *
 */
public interface AllowedContactRepository extends AbstractRepository<AllowedContact> {
	/**
	 * Find the allowed contact of some user
	 * @param owner the user
	 * @return
	 */
	List<AllowedContact> findByOwner(final User owner);
	/**
	 * Search the contacts of a guest by mail or name or firstName
	 * @param mail
	 * @param firstName
	 * @param lastName
	 * @param guest
	 * @return
	 */
	List<AllowedContact> searchContact(final Guest guest, final String mail, final String firstName,
			final String lastName);

	List<AllowedContact> completeContact(final Guest guest, final String pattern);

	List<AllowedContact> completeContact(final Guest guest, final String firstName, final String lastName);

	/**
	 * Delete all the AllowedContact pairs where user can be both a contact or
	 * an owner
	 * @param user
	 */
	void deleteAllByUserBothSides(final User user);

	/**
	 * Delete all contacts for a guest
	 * @param guest
	 * @throws BusinessException 
	 * @throws IllegalArgumentException 
	 */
	void purge(Guest guest) throws IllegalArgumentException, BusinessException;
}