Package io.goobi.viewer.api.rest.v2.annotations

Class AnnotationResource

java.lang.Object

io.goobi.viewer.api.rest.v2.annotations.AnnotationResource

@Path("/annotations")
public class AnnotationResource
extends Object

Author:

florian

Constructor Summary

Constructors

Constructor	Description
AnnotationResource()

Method Summary

Modifier and Type	Method	Description
de.intranda.api.annotation.IAnnotation	addAnnotation(de.intranda.api.annotation.IncomingAnnotation anno)
CrowdsourcingAnnotation	createPersistentAnnotation(de.intranda.api.annotation.IAnnotation anno)
de.intranda.api.annotation.IAnnotation	deleteAnnotation(Long id)
de.intranda.api.annotation.IAnnotation	getAnnotation(Long id)
de.intranda.api.annotation.wa.collection.AnnotationCollection	getAnnotationCollection()
de.intranda.api.annotation.wa.collection.AnnotationPage	getAnnotationCollectionPage(Integer page)
de.intranda.api.annotation.IAnnotation	getComment(Long id)
User	getUser()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AnnotationResource

public AnnotationResource()

Method Details

getAnnotationCollection

@GET
@Produces("application/json")
public de.intranda.api.annotation.wa.collection.AnnotationCollection getAnnotationCollection()
                                                                                      throws PresentationException,
IndexUnreachableException

Returns:

AnnotationCollection

Throws:

DAOException

IndexUnreachableException

PresentationException

getAnnotationCollectionPage

@GET
@Path("/{page}")
@Produces("application/json")
public de.intranda.api.annotation.wa.collection.AnnotationPage getAnnotationCollectionPage(@PathParam("page")
 Integer page)
                                                                                    throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException,
DAOException

Parameters:

page -

Returns:

AnnotationPage

Throws:

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getAnnotation

@GET
@Path("/annotation_{id}")
@Produces("application/json")
public de.intranda.api.annotation.IAnnotation getAnnotation(@PathParam("id")
 Long id)
                                                     throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Parameters:

id -

Returns:

IAnnotation

Throws:

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getComment

@GET
@Path("/comment_{id}")
@Produces("application/json")
public de.intranda.api.annotation.IAnnotation getComment(@PathParam("id")
 Long id)
                                                  throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Parameters:

id -

Returns:

IAnnotation

Throws:

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

addAnnotation

@POST
@Consumes("application/json")
@Produces("application/json")
public de.intranda.api.annotation.IAnnotation addAnnotation(de.intranda.api.annotation.IncomingAnnotation anno)
                                                     throws DAOException,
NotImplementedException

Parameters:

anno -

Returns:

IAnnotation

Throws:

DAOException

NotImplementedException

deleteAnnotation

@DELETE
@Path("/annotation_{id}")
@Produces("application/json")
public de.intranda.api.annotation.IAnnotation deleteAnnotation(@PathParam("id")
 Long id)
                                                        throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Parameters:

id -

Returns:

IAnnotation

Throws:

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

createPersistentAnnotation

public CrowdsourcingAnnotation createPersistentAnnotation(de.intranda.api.annotation.IAnnotation anno)

Parameters:

anno -

Returns:

CrowdsourcingAnnotation

getUser

public User getUser()

Returns:

User