/*
 * 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.web.workreports;

import java.util.List;
import java.util.Map;

import org.libreplan.business.common.exceptions.InstanceNotFoundException;
import org.libreplan.business.common.exceptions.ValidationException;
import org.libreplan.business.costcategories.entities.TypeOfWorkHours;
import org.libreplan.business.labels.entities.Label;
import org.libreplan.business.labels.entities.LabelType;
import org.libreplan.business.orders.entities.OrderElement;
import org.libreplan.business.resources.entities.Resource;
import org.libreplan.business.resources.entities.Worker;
import org.libreplan.business.users.entities.User;
import org.libreplan.business.workreports.entities.WorkReport;
import org.libreplan.business.workreports.entities.WorkReportLine;
import org.libreplan.business.workreports.entities.WorkReportType;
import org.libreplan.business.workreports.valueobjects.DescriptionField;
import org.libreplan.business.workreports.valueobjects.DescriptionValue;
import org.libreplan.web.common.IIntegrationEntityModel;
import org.zkoss.ganttz.IPredicate;

/**
 * Contract for {@link WorkRerportType}
 * @author Diego Pino García <dpino@igalia.com>
 * @author Susana Montes Pedreira <smontes@wirelessgalicia.com>
 */
public interface IWorkReportModel extends IIntegrationEntityModel {

    /**
     * Add new {@link WorkReportLine} to {@link WorkReport}
     *
     * @return
     */
    WorkReportLine addWorkReportLine();

    /**
     * Converts @{link Resource} to @{link Worker}
     * @param resource
     * @return
     * @throws InstanceNotFoundException
     */
    Worker asWorker(Resource resource) throws InstanceNotFoundException;

    /**
     * Finds an @{link OrdrElement} by code
     *
     * @param code
     * @return
     */
    OrderElement findOrderElement(String code) throws InstanceNotFoundException;

    /**
     * Find a @{link Worker} by nif
     *
     * @param nif
     * @return
     * @throws InstanceNotFoundException
     */
    Worker findWorker(String nif) throws InstanceNotFoundException;

    /**
     * Gets the current {@link WorkReport}.
     *
     * @return A {@link WorkReport}
     */
    WorkReport getWorkReport();

    /**
     * Gets the current {@link WorkReportType}.
     * @return A {@link WorkReportType}
     */
    WorkReportType getWorkReportType();

    /**
     * Return all {@link WorkReportLine} associated with current
     * {@link WorkReport}
     * @return
     */
    List<WorkReportLine> getWorkReportLines();

    /**
     * Get all {@link WorkReport} elements
     *
     * @return
     */
    List<WorkReportDTO> getWorkReportDTOs();

    /**
     * Get all {@link WorkReportType} elements
     * @return
     */
    List<WorkReportType> getWorkReportTypes();

    /**
     * Return all the {@link WorkReportLine}
     * @return
     */
    List<WorkReportLine> getAllWorkReportLines();

    /**
     * Return all the {@link WorkReportLine} are filtered by a predicate
     * @return
     */
    List<WorkReportLine> getFilterWorkReportLines(IPredicate predicate);

    /**
     * Returns true if {@link WorkReport} is being edited
     * @return
     */
    boolean isEditing();

    /**
     * Makes some operations needed before edit a {@link WorkReport}.
     * @param workReport
     *            The object to be edited
     */
    void initEdit(WorkReport workReport);

    /**
     * Makes some operations needed before create a new {@link WorkReport}.
     */
    void initCreate(WorkReportType workReportType);

    /**
     * Removes {@link WorkReport}
     *
     * @param workReport
     */
    void remove(WorkReport workReport);

    /**
     * Removes {@link WorkReportLine}
     *
     * @param workReportLine
     */
    void removeWorkReportLine(WorkReportLine workReportLine);

    /**
     * Stores the current {@link WorkReport}.
     *
     * @throws ValidationException
     *             If validation fails
     */
    void confirmSave() throws ValidationException;

    /**
     * Return all {@link DescriptionValue} and {@link Label} associated with
     * current {@link WorkReport}
     * @return
     */
    List<Object> getFieldsAndLabelsHeading();

    /**
     * Return all {@link DescriptionField} and {@link Label} associated with the
     * current {@link WorkReportType}
     * @return
     */
    List<Object> getFieldsAndLabelsLineByDefault();

    /**
     * Return all {@link DescriptionValue} and {@link Label} associated with
     * current {@link WorkReportLine}
     * @return
     */
    List<Object> getFieldsAndLabelsLine(WorkReportLine workReportLine);

    /**
     * Return all assigned {@link LabelType} and its {@link Label}
     * @return
     */
    Map<LabelType, List<Label>> getMapAssignedLabelTypes();

    /**
     * Change the default or the old {@link Label} to other new {@link Label} in
     * the current {@link WorkReport}
     * @return
     */
    void changeLabelInWorkReport(Label oldLabel, Label newLabel);

    /**
     * Change the default or the old {@link Label} to other new {@link Label} in
     * the current {@link WorkReportLine}
     * @return
     */
    void changeLabelInWorkReportLine(Label oldLabel, Label newLabel,
            WorkReportLine line);

    /**
     * Return the length description field associated with the description
     * value.
     * @return
     */
    Integer getLength(DescriptionValue descriptionValue);

    /**
     * checks if work report holds predicate. In case it's true, add workReport
     * and all its children to filtered workReports list
     * @return
     */
    List<WorkReportDTO> getFilterWorkReportDTOs(IPredicate predicate);

    /**
     * Return a selected default {@link WorkReportType} to filter the work reports
     * @return
     */
    WorkReportType getDefaultType();

    List<OrderElement> getOrderElements();

    void generateWorkReportLinesIfIsNecessary();

    List<TypeOfWorkHours> getAllHoursType();

    /**
     * Returns the list of {@link Worker Workers} bound to any {@link User}.
     */
    List<Worker> getBoundWorkers();

    /**
     * Checks if a {@link WorkReport} is or not a personal timesheet.
     */
    boolean isPersonalTimesheet(WorkReport workReport);

    WorkReportLine getFirstWorkReportLine();

    /**
     * Checks if an {@link OrderElement} is finished or not in any
     * {@link WorkReportLine} of this report or other report.
     */
    boolean isFinished(OrderElement orderElement);

}