/*
 * 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.orders.daos;

import java.util.Date;
import java.util.List;

import org.libreplan.business.common.daos.IIntegrationEntityDAO;
import org.libreplan.business.common.exceptions.InstanceNotFoundException;
import org.libreplan.business.externalcompanies.entities.ExternalCompany;
import org.libreplan.business.labels.entities.Label;
import org.libreplan.business.orders.entities.Order;
import org.libreplan.business.orders.entities.OrderElement;
import org.libreplan.business.orders.entities.OrderStatusEnum;
import org.libreplan.business.planner.entities.Task;
import org.libreplan.business.reports.dtos.CostExpenseSheetDTO;
import org.libreplan.business.reports.dtos.OrderCostsPerResourceDTO;
import org.libreplan.business.resources.entities.Criterion;
import org.libreplan.business.scenarios.entities.Scenario;
import org.libreplan.business.users.entities.User;

/**
 * Contract for {@link OrderDAO}.
 *
 * @author Óscar González Fernández <ogonzalez@igalia.com>
 * @author Lorenzo Tilve Álvaro <ltilve@igalia.com>
 * @author Diego Pino Garcia <dpino@igalia.com>
 * @author Jacobo Aragunde Pérez <jaragunde@igalia.com>
 * @author Vova Perebykivskyi <vova@libreplan-enterprise.com>
 */
public interface IOrderDAO extends IIntegrationEntityDAO<Order> {

    /**
     * Gets all the orders.
     *
     * @return A {@link List} of {@link Order} objects
     */
    List<Order> getOrders();

    /**
     * Builds contents for OrderCostsPerResource report.
     *
     * @return A {@link List} of {@link OrderCostsPerResourceDTO} objects for reporting
     */
    List<OrderCostsPerResourceDTO> getOrderCostsPerResource(
            List<Order> orders, Date startingDate, Date endingDate, List<Criterion> criterions);

    /**
     * Returns a list of orders filtered by the read authorizations of the indicated user.
     * Write authorizations are also counted, because they implicitly suppose read access.
     *
     * @param user User.
     * @return Filtered list of orders.
     */
    List<Order> getOrdersByReadAuthorization(User user);

    /**
     * Returns a list of orders filtered by the write authorizations of the indicated user.
     *
     * @param user User.
     * @return Filtered list of orders.
     */
    List<Order> getOrdersByWriteAuthorization(User user);

    List<Order> getOrdersByReadAuthorizationByScenario(String username, Scenario scenario);

    List<Order> getOrdersByReadAuthorizationBetweenDatesByLabelsCriteriaCustomerAndState(
            String username, Scenario scenario, Date startDate, Date endDate,
            List<Label> labels, List<Criterion> criteria,
            ExternalCompany customer, OrderStatusEnum state);

    /**
     * Returns the order filtered by the name.
     * If name is blank (whitespace, empty ("") or null, it throws <code>InstanceNotFoundException</code>.
     * 
     * @param name
     *            String
     * @return order Order
     */
    Order findByNameAnotherTransaction(String name) throws InstanceNotFoundException;

    List<Order> getOrdersByScenario(Scenario scenario);

    List<Task> getFilteredTask(List<OrderElement> orderElements, List<Criterion> criterions);

    Order loadOrderAvoidingProxyFor(OrderElement orderElement);

    List<Order> loadOrdersAvoidingProxyFor(List<OrderElement> orderElement);

    boolean existsByNameAnotherTransaction(String name);

    List<Order> getActiveOrders();

    List<CostExpenseSheetDTO> getCostExpenseSheet(
            List<Order> orders, Date startingDate, Date endingDate, List<Criterion> criterions);

    /**
     * Get {@link Order} where {@link Order#getCustomerReference()} is not NULL and not equals empty {@link String}.
     *
     * @return {@link List<Order>}
     */
    List<Order> getOrdersWithNotEmptyCustomersReferences();

}