Package com.flower.docs.service.api.annotation

Interface AnnotationService

public interface AnnotationService

Manages the Annotation of Document

Method Summary

Modifier and Type	Method	Description
void	create(com.flower.docs.domain.common.Id documentId, java.util.List<com.arondor.viewer.annotation.api.Annotation> annotations)	Create multiple annotations for a document
void	delete(com.flower.docs.domain.common.Id documentId)	Deletes all annotations of a document
void	delete(com.flower.docs.domain.common.Id documentId, java.util.List<com.flower.docs.domain.common.Id> annotationIds)	Deletes multiple annotations of a document
java.util.List<com.arondor.viewer.annotation.api.Annotation>	get(com.flower.docs.domain.common.Id documentId)	Gets all annotations of a document
void	update(com.flower.docs.domain.common.Id documentId, java.util.List<com.arondor.viewer.annotation.api.Annotation> annotations)	Updates multiple annotations of a document

Method Detail

create

void create(com.flower.docs.domain.common.Id documentId,
            java.util.List<com.arondor.viewer.annotation.api.Annotation> annotations)
     throws com.flower.docs.domain.exception.FunctionalException,
            com.flower.docs.domain.exception.TechnicalException

Create multiple annotations for a document

Parameters:

documentId - The identifier of the document to annotate

annotations - The annotations to create

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurs

com.flower.docs.domain.exception.TechnicalException - If a technical error occurs

get

java.util.List<com.arondor.viewer.annotation.api.Annotation> get(com.flower.docs.domain.common.Id documentId)
                                                          throws com.flower.docs.domain.exception.FunctionalException,
                                                                 com.flower.docs.domain.exception.TechnicalException

Gets all annotations of a document

Parameters:

documentId - The document identifier

Returns:

The annotations of document

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurs

com.flower.docs.domain.exception.TechnicalException - If a technical error occurs

update

void update(com.flower.docs.domain.common.Id documentId,
            java.util.List<com.arondor.viewer.annotation.api.Annotation> annotations)
     throws com.flower.docs.domain.exception.FunctionalException,
            com.flower.docs.domain.exception.TechnicalException

Updates multiple annotations of a document

Parameters:

documentId - The identifier of the document

annotations - Annotations to update

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurs

com.flower.docs.domain.exception.TechnicalException - If a technical error occurs

delete

void delete(com.flower.docs.domain.common.Id documentId,
            java.util.List<com.flower.docs.domain.common.Id> annotationIds)
     throws com.flower.docs.domain.exception.FunctionalException,
            com.flower.docs.domain.exception.TechnicalException

Deletes multiple annotations of a document

Parameters:

documentId - The identifier of the document

annotationIds - The identifiers of annotations to delete

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurs

com.flower.docs.domain.exception.TechnicalException - If a technical error occurs

delete

void delete(com.flower.docs.domain.common.Id documentId)
     throws com.flower.docs.domain.exception.FunctionalException,
            com.flower.docs.domain.exception.TechnicalException

Deletes all annotations of a document

Parameters:

documentId - The identifier of the document

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurs

com.flower.docs.domain.exception.TechnicalException - If a technical error occurs