de.digitalcollections.iiif.hymir.presentation.backend.api

Interface PresentationRepository

All Known Implementing Classes:

PresentationRepositoryImpl

public interface PresentationRepository

Interface to be implemented by project/user of this library.

Method Summary

Modifier and Type	Method and Description
de.digitalcollections.iiif.model.sharedcanvas.AnnotationList	getAnnotationList(String identifier, String name, String canvasId)
de.digitalcollections.iiif.model.sharedcanvas.Collection	getCollection(String name)
default Instant	getCollectionModificationDate(String identifier)
de.digitalcollections.iiif.model.sharedcanvas.Manifest	getManifest(String identifier)
default Instant	getManifestModificationDate(String identifier)

Method Detail

getAnnotationList

de.digitalcollections.iiif.model.sharedcanvas.AnnotationList getAnnotationList(String identifier,
                                                                               String name,
                                                                               String canvasId)
                                                                        throws ResolvingException,
                                                                               de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException,
                                                                               InvalidDataException

Parameters:

identifier - unique identifier of the corresponding manifest

name - unique name of annotation list

canvasId - name of the corresponding canvas

Returns:

AnnotationList specified by name

Throws:

ResolvingException - if no annotation list found

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException - if annotation list with given name can not be found

InvalidDataException - if data is corrupted

getCollection

de.digitalcollections.iiif.model.sharedcanvas.Collection getCollection(String name)
                                                                throws ResolvingException,
                                                                       de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException,
                                                                       InvalidDataException

Parameters:

name - unique name of collection

Returns:

Collection specified by name

Throws:

ResolvingException - in case Collection does not exist or can not be delivered

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException - if Collection with given name can not be found

InvalidDataException - if collection contains invalid data

getManifest

de.digitalcollections.iiif.model.sharedcanvas.Manifest getManifest(String identifier)
                                                            throws ResolvingException,
                                                                   de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException,
                                                                   InvalidDataException

Parameters:

identifier - unique id for IIIF resource

Returns:

Manifest specifying presentation for IIIF resource

Throws:

ResolvingException - in case Manifest does not exist or can not be delivered

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException - if Manifest with given identifier can not be found

InvalidDataException - if manifest contains invalid data

getManifestModificationDate

default Instant getManifestModificationDate(String identifier)
                                     throws ResolvingException,
                                            de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException

Throws:

ResolvingException

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException

getCollectionModificationDate

default Instant getCollectionModificationDate(String identifier)
                                       throws ResolvingException,
                                              de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException

Throws:

ResolvingException

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException