/*
 * This file is part of LibrePlan
 *
 * Copyright (C) 2009-2010 Fundación para o Fomento da Calidade Industrial e
 *                         Desenvolvemento Tecnolóxico de Galicia
 * Copyright (C) 2010-2011 Igalia, S.L.
 *
 * 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.
 *
 * 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
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.libreplan.business.common.daos;

import java.util.List;

import org.libreplan.business.common.IntegrationEntity;
import org.libreplan.business.common.exceptions.InstanceNotFoundException;

/**
 * Common DAO interface for all entities used in application integration. All
 * DAO interfaces of entities used in application integration must extend from
 * this interface.
 *
 * @author Fernando Bellas Permuy <fbellas@udc.es>
 */
public interface IIntegrationEntityDAO<E extends IntegrationEntity>
    extends IGenericDAO<E, Long> {

    /**
     * If <code>code</code> is blank (whitespace, empty ("") or
     * <code>null</code>), it returns <code>false</code>.
     */
    public boolean existsByCode(String code);

    /**
     * If <code>code</code> is blank (whitespace, empty ("") or
     * <code>null</code>), it returns <code>false</code>.
     */
    public boolean existsByCodeAnotherTransaction(String code);

    /**
     * If <code>code</code> is blank (whitespace, empty ("") or
     * <code>null</code>), it throws <code>InstanceNotFoundException</code>.
     */
    public E findByCode(String code) throws InstanceNotFoundException;

    /**
     * If <code>code</code> is blank (whitespace, empty ("") or
     * <code>null</code>), it throws <code>InstanceNotFoundException</code>.
     */
    public E findByCodeAnotherTransaction(String code)
        throws InstanceNotFoundException;

    public E findExistingEntityByCode(String code);

    /**
     * It returns all entities ordered by ascending code.
     */
    public List<E> findAll();

}