Skip to content
Snippets Groups Projects
Commit 258f33a8 authored by Sven Kästle's avatar Sven Kästle
Browse files

feat: Add first version of the 'annotatable' interface

parent 0a50775a
No related branches found
No related tags found
No related merge requests found
package unipotsdam.gf.interfaces;
/**
* @author Sven Kästle
* skaestle@uni-potsdam.de
*/
public interface Annotatable {
/**
* Adds an annotation to a document and returns the new id
*
* @param userId The id of the author of the annotation
* @param annotation The annotation as an Object
* @return Returns the id of the new annotation
*/
String addAnnotation(String userId, Object annotation);
/**
* Alters an annotation
*
* @param id The id of the annotation
* @param annotation The annotation as an Object
*/
void alterAnnotation(String id, Object annotation);
/**
* Deletes an annotation
*
* @param id The id of the annotation
*/
void deleteAnnotation(String id);
/**
* Returns a specific annotation from a document
*
* @param id The id of the annotation
* @return Returns a specific annotation
*/
Object getAnnotation(String id);
/**
* Return all annotations from a document
*
* @return Returns all annotations
*/
Object[] getAnnotations();
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment