Package io.goobi.viewer.api.rest.resourcebuilders

Class AbstractBookmarkResourceBuilder

java.lang.Object

io.goobi.viewer.api.rest.resourcebuilders.AbstractBookmarkResourceBuilder

Direct Known Subclasses:

SessionBookmarkResourceBuilder, UserBookmarkResourceBuilder

public abstract class AbstractBookmarkResourceBuilder
extends Object

Author:

florian

Constructor Summary

Constructors

Constructor	Description
AbstractBookmarkResourceBuilder()

Method Summary

Modifier and Type	Method	Description
abstract SuccessMessage	addBookmarkList()
abstract SuccessMessage	addBookmarkList(String name)
abstract SuccessMessage	addBookmarkToBookmarkList(Long id, String pi)
abstract SuccessMessage	addBookmarkToBookmarkList(Long id, String pi, String logId, String pageString)
abstract de.intranda.api.iiif.presentation.v2.Collection2	createCollection(BookmarkList list, AbstractApiUrlManager urls)
protected de.intranda.api.iiif.presentation.v2.Collection2	createCollection(BookmarkList list, String url)
abstract SuccessMessage	deleteBookmarkFromBookmarkList(Long id, String pi)
abstract SuccessMessage	deleteBookmarkFromBookmarkList(Long id, String pi, String logId, String pageString)
abstract SuccessMessage	deleteBookmarkList(Long id)
abstract List<BookmarkList>	getAllBookmarkLists()
List<BookmarkList>	getAllPublicBookmarkLists()	Returns all public bookmark lists
abstract de.intranda.api.iiif.presentation.v2.Collection2	getAsCollection(Long id, AbstractApiUrlManager urls)
de.intranda.api.iiif.presentation.v2.Collection2	getAsCollection(String sharedKey, AbstractApiUrlManager urls)	getAsCollection.
abstract BookmarkList	getBookmarkListById(Long id)
abstract String	getBookmarkListForMirador(Long id, AbstractApiUrlManager urls)
Integer	getPageOrder(String pageString)	getPageOrder.
BookmarkList	getSharedBookmarkList(String shareKey)
String	getSharedBookmarkListForMirador(String key, AbstractApiUrlManager urls)
abstract void	updateBookmarkList(BookmarkList orig)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBookmarkResourceBuilder

public AbstractBookmarkResourceBuilder()

Method Details

getAllBookmarkLists

public abstract List<BookmarkList> getAllBookmarkLists()
                                                throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

addBookmarkList

public abstract SuccessMessage addBookmarkList()
                                        throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Throws:

DAOException

IOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

addBookmarkList

public abstract SuccessMessage addBookmarkList(String name)
                                        throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Throws:

DAOException

IOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getBookmarkListById

public abstract BookmarkList getBookmarkListById(Long id)
                                          throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

deleteBookmarkList

public abstract SuccessMessage deleteBookmarkList(Long id)
                                           throws DAOException,
IOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

Throws:

DAOException

IOException

RestApiException

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

getAsCollection

public abstract de.intranda.api.iiif.presentation.v2.Collection2 getAsCollection(Long id,
 AbstractApiUrlManager urls)
                                                                          throws DAOException,
RestApiException,
IOException

Throws:

DAOException

RestApiException

IOException

getBookmarkListForMirador

public abstract String getBookmarkListForMirador(Long id,
 AbstractApiUrlManager urls)
                                          throws DAOException,
IOException,
RestApiException,
ViewerConfigurationException,
IndexUnreachableException,
PresentationException

Throws:

DAOException

IOException

RestApiException

ViewerConfigurationException

IndexUnreachableException

PresentationException

addBookmarkToBookmarkList

public abstract SuccessMessage addBookmarkToBookmarkList(Long id,
 String pi,
 String logId,
 String pageString)
                                                  throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

addBookmarkToBookmarkList

public abstract SuccessMessage addBookmarkToBookmarkList(Long id,
 String pi)
                                                  throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

deleteBookmarkFromBookmarkList

public abstract SuccessMessage deleteBookmarkFromBookmarkList(Long id,
 String pi,
 String logId,
 String pageString)
                                                       throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

deleteBookmarkFromBookmarkList

public abstract SuccessMessage deleteBookmarkFromBookmarkList(Long id,
 String pi)
                                                       throws DAOException,
IOException,
RestApiException

Throws:

DAOException

IOException

RestApiException

createCollection

public abstract de.intranda.api.iiif.presentation.v2.Collection2 createCollection(BookmarkList list,
 AbstractApiUrlManager urls)

getPageOrder

public Integer getPageOrder(String pageString)

getPageOrder.

Parameters:

pageString - a String object.

Returns:

a Integer object.

getSharedBookmarkListForMirador

public String getSharedBookmarkListForMirador(String key,
 AbstractApiUrlManager urls)
                                       throws DAOException,
PresentationException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
ViewerConfigurationException,
IndexUnreachableException

Throws:

DAOException

PresentationException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

ViewerConfigurationException

IndexUnreachableException

getAllPublicBookmarkLists

public List<BookmarkList> getAllPublicBookmarkLists()
                                             throws DAOException,
IOException,
RestApiException

Returns all public bookmark lists

Returns:

a List object.

Throws:

DAOException - if any.

IOException - if any.

RestApiException - if any.

getAsCollection

public de.intranda.api.iiif.presentation.v2.Collection2 getAsCollection(String sharedKey,
 AbstractApiUrlManager urls)
                                                                 throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
DAOException

getAsCollection.

Parameters:

sharedKey -

urls -

Returns:

a Collection2 object.

Throws:

DAOException - if any.

RestApiException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

createCollection

protected de.intranda.api.iiif.presentation.v2.Collection2 createCollection(BookmarkList list,
 String url)

Parameters:

list -

url -

Returns:

Collection2

getSharedBookmarkList

public BookmarkList getSharedBookmarkList(String shareKey)
                                   throws DAOException,
RestApiException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Parameters:

shareKey -

Returns:

BookmarkList

Throws:

DAOException - If an error occured talking to the database

RestApiException - If no user session exists or if the user has no access to the requested list

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException - If no list with the given key was found

updateBookmarkList

public abstract void updateBookmarkList(BookmarkList orig)
                                 throws de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException,
DAOException

Parameters:

orig -

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.IllegalRequestException

DAOException