001/*
002 * (C) Copyright 2006-2009 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Nuxeo - initial API and implementation
016 *
017 * $Id$
018 */
019
020package org.nuxeo.ecm.platform.annotations.api;
021
022import java.net.URI;
023import java.util.List;
024import java.util.Map;
025
026import org.nuxeo.ecm.core.api.NuxeoPrincipal;
027import org.nuxeo.ecm.platform.relations.api.Graph;
028
029/**
030 * Interface for the Annotation Service
031 *
032 * @author tiry
033 */
034public interface AnnotationsService {
035
036    Graph getAnnotationGraph();
037
038    /**
039     * Finds Annotation ids according to URI.
040     */
041    List<Annotation> queryAnnotations(URI uri, NuxeoPrincipal user);
042
043    /**
044     * Finds number of Annotation according to URI.
045     */
046    int getAnnotationsCount(URI uri, NuxeoPrincipal user);
047
048    /**
049     * Returns an Annotation according to its Id.
050     */
051    Annotation getAnnotation(String annotationId, NuxeoPrincipal user, String baseUrl);
052
053    /**
054     * Adds an annotation to the target URL.
055     *
056     * @return the Annotation
057     */
058    Annotation addAnnotation(Annotation annotation, NuxeoPrincipal user, String baseUrl);
059
060    /**
061     * Updates an annotation.
062     */
063    Annotation updateAnnotation(Annotation annotation, NuxeoPrincipal user, String baseUrl);
064
065    /**
066     * Deletes an annotation.
067     */
068    void deleteAnnotation(Annotation annotation, NuxeoPrincipal user);
069
070    void deleteAnnotationFor(URI uri, Annotation annotation, NuxeoPrincipal user);
071
072}