org.nuxeo.ecm.platform.comment.api

Interface AnnotationService

All Known Implementing Classes:

AnnotationServiceImpl

public interface AnnotationService

Annotation API to perform CRUD operations on annotations.

Since:

10.1

Method Summary

Modifier and Type	Method and Description
Annotation	createAnnotation(CoreSession session, Annotation annotation) Creates an annotation on a document.
void	deleteAnnotation(CoreSession session, String annotationId) Deletes an annotation for a document.
void	deleteExternalAnnotation(CoreSession session, String entityId) Deletes an external annotation.
Annotation	getAnnotation(CoreSession session, String annotationId) Gets an annotation.
List<Annotation>	getAnnotations(CoreSession session, String documentId, String xpath) Gets all annotations for a document.
Annotation	getExternalAnnotation(CoreSession session, String entityId) Gets an annotation generated by an external service.
void	updateAnnotation(CoreSession session, String annotationId, Annotation annotation) Updates an annotation for a document.
void	updateExternalAnnotation(CoreSession session, String entityId, Annotation annotation) Updates an external annotation.

Method Detail

createAnnotation

Annotation createAnnotation(CoreSession session,
                            Annotation annotation)
                     throws CommentSecurityException

Creates an annotation on a document.

Parameters:

session - the core session

annotation - the annotation to create

Returns:

the created annotation

Throws:

CommentSecurityException - if the current user does have the right permissions on the document to annotate.

getAnnotation

Annotation getAnnotation(CoreSession session,
                         String annotationId)
                  throws CommentNotFoundException,
                         CommentSecurityException

Gets an annotation.

Parameters:

session - the core session

annotationId - the annotation document model id

Returns:

the annotation, or null if the annotation with the given id was not found

Throws:

CommentNotFoundException - if no annotation was found with the given id

CommentSecurityException - if the current user does have the right permissions on the annotated document.

getAnnotations

List<Annotation> getAnnotations(CoreSession session,
                                String documentId,
                                String xpath)
                         throws CommentNotFoundException,
                                CommentSecurityException

Gets all annotations for a document.

Parameters:

session - the core session

documentId - the annotated document id

xpath - the annotated blob xpath in the document

Returns:

the list of annotations, or an empty list if no annotation is found

Throws:

CommentNotFoundException - if no annotation was found with the given id

CommentSecurityException - if the current user does have the right permissions on the annotated document.

updateAnnotation

void updateAnnotation(CoreSession session,
                      String annotationId,
                      Annotation annotation)
               throws CommentNotFoundException,
                      CommentSecurityException

Updates an annotation for a document.

Parameters:

session - the core session

annotationId - the annotation document model id

annotation - the annotation containing the modifications

Throws:

CommentNotFoundException - if no annotation was found with the given id

CommentSecurityException - if the current user does have the right permissions on the annotated document.

deleteAnnotation

void deleteAnnotation(CoreSession session,
                      String annotationId)
               throws CommentNotFoundException,
                      CommentSecurityException

Deletes an annotation for a document.

Parameters:

session - the core session

annotationId - the annotation document model id

Throws:

CommentNotFoundException - if no annotation was found with the given id

CommentSecurityException - if the current user does have the right permissions on the annotated document.

getExternalAnnotation

Annotation getExternalAnnotation(CoreSession session,
                                 String entityId)
                          throws CommentNotFoundException,
                                 CommentSecurityException

Gets an annotation generated by an external service.

Parameters:

session - the core session

entityId - the annotation entity id

Returns:

the annotation

Throws:

CommentNotFoundException - if no annotation was found with the given external entity id

CommentSecurityException - if the current user does have the right permissions on the annotated document.

Since:

10.3

updateExternalAnnotation

void updateExternalAnnotation(CoreSession session,
                              String entityId,
                              Annotation annotation)
                       throws CommentNotFoundException,
                              CommentSecurityException

Updates an external annotation.

Parameters:

session - the core session

entityId - the annotation document model id

annotation - the annotation containing the modifications

Throws:

CommentNotFoundException - if no annotation was found with the given external entity id

CommentSecurityException - if the current user does have the right permissions on the annotated document.

Since:

10.3

deleteExternalAnnotation

void deleteExternalAnnotation(CoreSession session,
                              String entityId)
                       throws CommentNotFoundException,
                              CommentSecurityException

Deletes an external annotation.

Parameters:

session - the core session

entityId - the annotation entity id

Throws:

CommentNotFoundException - if no annotation was found with the given external entity id

CommentSecurityException - if the current user does have the right permissions on the annotated document.

Since:

10.3