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

import java.util.List;

import org.libreplan.business.common.exceptions.ValidationException;
import org.libreplan.business.labels.entities.Label;
import org.libreplan.business.labels.entities.LabelType;
import org.libreplan.web.common.IIntegrationEntityModel;

/**
 * Interface for {@link LabelTypeModel}
 * @author Diego Pino Garcia <dpino@igalia.com>
 */
public interface ILabelTypeModel extends IIntegrationEntityModel {

    /**
     * Removes {@link LabelType}
     * @param labelType
     */
    void confirmDelete(LabelType labelType);

    /**
     * Ends conversation saving current {@link LabelType}
     */
    void confirmSave() throws ValidationException;

    /**
     * Returns {@link LabelType}
     * @return
     */
    LabelType getLabelType();

    /**
     * Returns all {@link LabelType}
     * @return
     */
    List<LabelType> getLabelTypes();

    /**
     * Starts conversation creating new {@link LabelType}
     */
    void initCreate();

    /**
     * Starts conversation editing {@link LabelType}
     */
    void initEdit(LabelType labelType);

    /**
     * Returns all {@link Label} for current {@link LabelType}
     * @return
     */
    List<Label> getLabels();

    /**
     * Add {@link Label} to {@link LabelType}
     */
    void addLabel(String value);

    /**
     * @param label
     */
    void confirmDeleteLabel(Label label);

    /**
     * Check is {@link Label} name is unique
     * @param value
     */
    boolean labelNameIsUnique(String value);

    /**
     * Check is {@link Label} name is not empty
     * @param value
     */
    void validateNameNotEmpty(String name) throws ValidationException;

    /**
     * Check is {@link Label} name is unique
     * @param value
     */
    void thereIsOtherWithSameNameAndType(String name)
            throws ValidationException;

    /**
     * Generate codes for Labels if autogenerated
     */
    void generateCodes();

}