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

import fr.mcc.ginco.exceptions.TechnicalException;
import fr.mcc.ginco.exports.result.bean.GincoExportedBranch;
import fr.mcc.ginco.exports.result.bean.GincoExportedThesaurus;

/**
 * This service provides functions to use for Ginco export by REST services.
 */
public interface IGincoExportServiceUtil {

	/**
	 * This method serializes to XML a thesaurus with Jaxb
	 * 
	 * @param thesaurusToExport : the thesaurus we want to export
	 * @return serializedThesaurus : the thesaurus we have serialized
	 * @throws TechnicalException
	 */
	String serializeThesaurusToXmlWithJaxb(
			GincoExportedThesaurus thesaurusToExport) throws TechnicalException;

	/**
	 * This method serializes to XML a concept branch with Jaxb
	 * 
	 * @param branchToExport : the branch we want to export
	 * @return serializedBranch : the concept and its children (+ notes, versions) we have serialized
	 * @throws TechnicalException
	 */
	String serializeBranchToXmlWithJaxb(GincoExportedBranch branchToExport)
			throws TechnicalException;
}