Interface PresentationService

  • All Known Implementing Classes:
    PresentationServiceImpl

    public interface PresentationService
    Service for IIIF Presentation API functionality.
    • 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:
        name - unique name of annotation list
        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 - if no collection found or access disallowed
        de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException - if collection with given name can not be found
        InvalidDataException - if data is corrupted
      • 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 - if no manifest found or access disallowed
        de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceNotFoundException - if Manifest with given identifier can not be found
        InvalidDataException - if data is corrupted
      • 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
      • copyAttributionInfo

        default <T extends de.digitalcollections.iiif.model.sharedcanvas.Resource> T copyAttributionInfo​(de.digitalcollections.iiif.model.sharedcanvas.Manifest manifest,
                                                                                                         T res)