com.arondor.viewer.rendition.api.annotation

Interface AnnotationAccessor

All Superinterfaces:

AnnotationCreationPolicyProvider

All Known Subinterfaces:

AnnotationPageAccessor

public interface AnnotationAccessor
extends AnnotationCreationPolicyProvider

CRUD-based Annotation accessor interface

Author:

Francois Barre

Method Summary

Modifier and Type	Method and Description
void	create(List<Annotation> annotations) Create a list of new annotations
void	delete(List<Annotation> annotations) Delete a list of existing annotations
List<Annotation>	get() Get the list of existing annotations
void	update(List<Annotation> annotations) Update a list of existing annotations

Methods inherited from interface com.arondor.viewer.rendition.api.annotation.AnnotationCreationPolicyProvider

getAnnotationCreationPolicy

Method Detail

create

void create(List<Annotation> annotations)
     throws AnnotationsNotSupportedException,
            AnnotationCredentialsException,
            InvalidAnnotationFormatException,
            AnnotationNotAvailableException

Create a list of new annotations

Parameters:

annotations - the annotations to create

Throws:

AnnotationsNotSupportedException - if this AnnotationAccessor does not support annotations

AnnotationCredentialsException - if the user does not have rights to create an annotation

AnnotationNotAvailableException - if an annotation with the same Id already exists

InvalidAnnotationFormatException - if the annotations format is not supported

update

void update(List<Annotation> annotations)
     throws AnnotationsNotSupportedException,
            AnnotationNotAvailableException,
            AnnotationCredentialsException,
            InvalidAnnotationFormatException

Update a list of existing annotations

Parameters:

annotations - the annotations to update

Throws:

AnnotationsNotSupportedException - if this AnnotationAccessor does not support annotations

AnnotationCredentialsException - if the user does not have rights to update an annotation

AnnotationNotAvailableException - if an annotation does not exist and can not be updated

InvalidAnnotationFormatException - if the annotations format is not supported

get

List<Annotation> get()
              throws AnnotationsNotSupportedException,
                     AnnotationCredentialsException,
                     InvalidAnnotationFormatException

Get the list of existing annotations

Returns:

the list of existing annotations

Throws:

AnnotationsNotSupportedException - if this AnnotationAccessor does not support annotations

AnnotationCredentialsException - if the user does not have rights to get annotations

InvalidAnnotationFormatException - if the annotations format is not supported

delete

void delete(List<Annotation> annotations)
     throws AnnotationsNotSupportedException,
            AnnotationCredentialsException,
            AnnotationNotAvailableException,
            InvalidAnnotationFormatException

Delete a list of existing annotations

Parameters:

annotations - the annotations to delete

Throws:

AnnotationsNotSupportedException - if this AnnotationAccessor does not support annotations

AnnotationCredentialsException - if the user does not have rights to delete an annotation

AnnotationNotAvailableException - if an annotation does not exist and can not be deleted

InvalidAnnotationFormatException - if the annotations format is not supported