Nuxeo ECM Projects 5.4.3-SNAPSHOT

org.nuxeo.ecm.platform.annotations.api
Interface AnnotationsService

All Known Implementing Classes:
AnnotationServiceProxy, AnnotationsServiceImpl

public interface AnnotationsService

Interface for the Annotation Service

Author:
tiry

Method Summary
 Annotation addAnnotation(Annotation annotation, NuxeoPrincipal user, String baseUrl)
          Adds an annotation to the target URL.
 void deleteAnnotation(Annotation annotation, NuxeoPrincipal user)
          Deletes an annotation.
 void deleteAnnotationFor(URI uri, Annotation annotation, NuxeoPrincipal user)
           
 Annotation getAnnotation(String annotationId, NuxeoPrincipal user, String baseUrl)
          Returns an Annotation according to its Id.
 Graph getAnnotationGraph()
           
 List<Annotation> queryAnnotations(URI uri, Map<String,String> filters, NuxeoPrincipal user)
          Finds Annotation ids according to URI and filter.
 Annotation updateAnnotation(Annotation annotation, NuxeoPrincipal user, String baseUrl)
          Updates an annotation.
 

Method Detail

getAnnotationGraph

Graph getAnnotationGraph()
                         throws AnnotationException
Throws:
AnnotationException

queryAnnotations

List<Annotation> queryAnnotations(URI uri,
                                  Map<String,String> filters,
                                  NuxeoPrincipal user)
                                  throws AnnotationException
Finds Annotation ids according to URI and filter.

Throws:
AnnotationException

getAnnotation

Annotation getAnnotation(String annotationId,
                         NuxeoPrincipal user,
                         String baseUrl)
                         throws AnnotationException
Returns an Annotation according to its Id.

Throws:
AnnotationException

addAnnotation

Annotation addAnnotation(Annotation annotation,
                         NuxeoPrincipal user,
                         String baseUrl)
                         throws AnnotationException
Adds an annotation to the target URL.

Returns:
the Annotation
Throws:
AnnotationException

updateAnnotation

Annotation updateAnnotation(Annotation annotation,
                            NuxeoPrincipal user,
                            String baseUrl)
                            throws AnnotationException
Updates an annotation.

Throws:
AnnotationException

deleteAnnotation

void deleteAnnotation(Annotation annotation,
                      NuxeoPrincipal user)
                      throws AnnotationException
Deletes an annotation.

Throws:
AnnotationException

deleteAnnotationFor

void deleteAnnotationFor(URI uri,
                         Annotation annotation,
                         NuxeoPrincipal user)
                         throws AnnotationException
Throws:
AnnotationException

Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.