/**
 * 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 java.util.List;

import fr.mcc.ginco.beans.Note;

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

	/**
     * Get list of paginated notes available for a concept.
     * @return
     */
    List<Note> getConceptNotePaginatedList(String conceptId, Integer startIndex, Integer limit);

	/**
     * Get list of paginated notes available for a term.
     * @return
     */
    List<Note> getTermNotePaginatedList(String termId, Integer startIndex, Integer limit);

	/**
	 * Get a note by id
	 * @param id
	 * @return Note
	 */
	Note getNoteById(String id);


	/**
	 * Create or update a new note
	 * @param note
	 * @return the created or updated note
	 */
	Note createOrUpdateNote(Note note);

	/**
	 * Delete a note
	 * @param note
	 * @return the delete note
	 */
	Note deleteNote(Note note);

	/**
	 * Count the number of notes for a concept
	 * @param conceptId
	 * @return
	 */
	Long getConceptNoteCount(String conceptId);

	/**
	 * Count the number of notes for a term
	 * @param conceptId
	 * @return
	 */
	Long getTermNoteCount(String termId);

	/**
     * For indexing purposes
      * @return list of all existing notes
     */
	List<Note> getAllNotes();

	/**
     * For indexing purposes
     *  @param thesaurusId
      * @return list of all notes in a given thesaurus
     */
	List<Note> getNotesByThesaurusId(String thesaurusId);

}