001/* 002 * (C) Copyright 2006-2009 Nuxeo SA (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 * 016 * Contributors: 017 * Nuxeo - initial API and implementation 018 * 019 * $Id$ 020 */ 021 022package org.nuxeo.ecm.platform.annotations.api; 023 024import java.net.URI; 025import java.util.List; 026import java.util.Map; 027 028import org.nuxeo.ecm.core.api.NuxeoPrincipal; 029import org.nuxeo.ecm.platform.relations.api.Graph; 030 031/** 032 * Interface for the Annotation Service 033 * 034 * @author tiry 035 */ 036public interface AnnotationsService { 037 038 Graph getAnnotationGraph(); 039 040 /** 041 * Finds Annotation ids according to URI. 042 */ 043 List<Annotation> queryAnnotations(URI uri, NuxeoPrincipal user); 044 045 /** 046 * Finds number of Annotation according to URI. 047 */ 048 int getAnnotationsCount(URI uri, NuxeoPrincipal user); 049 050 /** 051 * Returns an Annotation according to its Id. 052 */ 053 Annotation getAnnotation(String annotationId, NuxeoPrincipal user, String baseUrl); 054 055 /** 056 * Adds an annotation to the target URL. 057 * 058 * @return the Annotation 059 */ 060 Annotation addAnnotation(Annotation annotation, NuxeoPrincipal user, String baseUrl); 061 062 /** 063 * Updates an annotation. 064 */ 065 Annotation updateAnnotation(Annotation annotation, NuxeoPrincipal user, String baseUrl); 066 067 /** 068 * Deletes an annotation. 069 */ 070 void deleteAnnotation(Annotation annotation, NuxeoPrincipal user); 071 072 void deleteAnnotationFor(URI uri, Annotation annotation, NuxeoPrincipal user); 073 074}