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

Interface PresentationRepository

  • All Known Implementing Classes:
    PresentationRepositoryImpl
    @Deprecated(forRemoval=true)
public interface PresentationRepository
    Deprecated, for removal: This API element is subject to removal in a future version.
    Interface to be implemented by project/user of this library.

    • Method Detail

      • getAnnotationList

        de.digitalcollections.iiif.model.sharedcanvas.AnnotationList getAnnotationList​(String identifier,
                                                                               String name,
                                                                               String canvasId)
                                                                        throws ResolvingException,
                                                                               de.digitalcollections.model.exception.ResourceNotFoundException,
                                                                               InvalidDataException
        Deprecated, for removal: This API element is subject to removal in a future version.
        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.exception.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.exception.ResourceNotFoundException,
                                                                       InvalidDataException
        Deprecated, for removal: This API element is subject to removal in a future version.
        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.exception.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.exception.ResourceNotFoundException,
                                                                   InvalidDataException
        Deprecated, for removal: This API element is subject to removal in a future version.
        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.exception.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.exception.ResourceNotFoundException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Throws:
        ResolvingException
        de.digitalcollections.model.exception.ResourceNotFoundException

      • getCollectionModificationDate

        default Instant getCollectionModificationDate​(String identifier)
                                       throws ResolvingException,
                                              de.digitalcollections.model.exception.ResourceNotFoundException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Throws:
        ResolvingException
        de.digitalcollections.model.exception.ResourceNotFoundException