/**
 * Copyright or © or Copr. Ministère Français chargé de la Culture
 * et de la Communication (2013)
 * <p/>
 * contact.gincoculture_at_gouv.fr
 * <p/>
 * This software is a computer program whose purpose is to provide a thesaurus
 * management solution.
 * <p/>
 * This software is governed by the CeCILL license under French law and
 * abiding by the rules of distribution of free software. You can use,
 * modify and/ or redistribute the software under the terms of the CeCILL
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info".
 * <p/>
 * As a counterpart to the access to the source code and rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty and the software's author, the holder of the
 * economic rights, and the successive licensors have only limited liability.
 * <p/>
 * In this respect, the user's attention is drawn to the risks associated
 * with loading, using, modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean that it is complicated to manipulate, and that also
 * therefore means that it is reserved for developers and experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systemsand/or
 * data to be ensured and, more generally, to use and operate it in the
 * same conditions as regards security.
 * <p/>
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL license and that you accept its terms.
 */
package fr.mcc.ginco.services;

import fr.mcc.ginco.beans.Thesaurus;
import fr.mcc.ginco.beans.ThesaurusConceptGroup;
import fr.mcc.ginco.beans.ThesaurusConceptGroupLabel;

import java.util.List;

/**
 * Service used to work with {@link fr.mcc.ginco.beans.ThesaurusConceptGroup} objects, contains basic
 * methods exposed to client part.
 *
 * @see fr.mcc.ginco.beans.ThesaurusConceptGroup
 */
public interface IThesaurusConceptGroupService {

	/**
	 * This method gets a {@link ThesaurusConceptGroup} by its identifier.
	 *
	 * @param conceptGroupId
	 * @return A {@link ThesaurusConceptGroup} object
	 */
	ThesaurusConceptGroup getConceptGroupById(String conceptGroupId);

	/**
	 * This method updates a concept group with its associated label.
	 *
	 * @param convertedConceptGroup
	 * @param conceptGroupLabel
	 * @return The {@link ThesaurusConceptGroup} object updated
	 */
	ThesaurusConceptGroup updateThesaurusConceptGroup(
			ThesaurusConceptGroup convertedConceptGroup,
			ThesaurusConceptGroupLabel conceptGroupLabel);

	/**
	 * Get all the {@link ThesaurusConceptGroup} of a {@link fr.mcc.ginco.beans.Thesaurus},
	 * excluding the group which id is given in parameter (optional, set null for no exclusion)
	 *
	 * @param thesaurusId
	 * @return A list of all {@link ThesaurusConceptGroup} belonging to the {@link Thesaurus} which id is given in parameter
	 */
	List<ThesaurusConceptGroup> getAllThesaurusConceptGroupsByThesaurusId(String excludedConceptGroupId,
			String thesaurusId);

	/**
	 * Destroy a ThesaurusConceptGroup.
	 *
	 * @param object the {@link ThesaurusConceptGroup} to delete
	 * @return the deleted {@link ThesaurusConceptGroup}
	 */
	ThesaurusConceptGroup destroyThesaurusConceptGroup(ThesaurusConceptGroup object);

	/**
	 * Get all child {@link ThesaurusConceptGroup} of a group by its identifier.
	 *
	 * @param conceptGroupId
	 * @return A list of all child {@link ThesaurusConceptGroup} of a group
	 */
	List<ThesaurusConceptGroup> getChildGroups(String conceptGroupId);

}