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

Modifier and Type	Method and Description
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()
int	getAnnotationsCount(URI uri, NuxeoPrincipal user) Finds number of Annotation according to URI.
List<Annotation>	queryAnnotations(URI uri, NuxeoPrincipal user) Finds Annotation ids according to URI.
Annotation	updateAnnotation(Annotation annotation, NuxeoPrincipal user, String baseUrl) Updates an annotation.

Method Detail

getAnnotationGraph

Graph getAnnotationGraph()

queryAnnotations

List<Annotation> queryAnnotations(URI uri,
                                  NuxeoPrincipal user)

Finds Annotation ids according to URI.

getAnnotationsCount

int getAnnotationsCount(URI uri,
                        NuxeoPrincipal user)

Finds number of Annotation according to URI.

getAnnotation

Annotation getAnnotation(String annotationId,
                         NuxeoPrincipal user,
                         String baseUrl)

Returns an Annotation according to its Id.

addAnnotation

Annotation addAnnotation(Annotation annotation,
                         NuxeoPrincipal user,
                         String baseUrl)

Adds an annotation to the target URL.

Returns:

the Annotation

updateAnnotation

Annotation updateAnnotation(Annotation annotation,
                            NuxeoPrincipal user,
                            String baseUrl)

Updates an annotation.

deleteAnnotation

void deleteAnnotation(Annotation annotation,
                      NuxeoPrincipal user)

Deletes an annotation.

deleteAnnotationFor

void deleteAnnotationFor(URI uri,
                         Annotation annotation,
                         NuxeoPrincipal user)