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

Interface PresentationService

  • All Known Implementing Classes:
    PresentationServiceImpl
    @Deprecated(forRemoval=true)
public interface PresentationService
    Deprecated, for removal: This API element is subject to removal in a future version.
    Service for IIIF Presentation API functionality.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      default <T extends de.digitalcollections.iiif.model.sharedcanvas.Resource>
      T      		 copyAttributionInfo​(de.digitalcollections.iiif.model.sharedcanvas.Manifest manifest, T res)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      de.digitalcollections.iiif.model.sharedcanvas.AnnotationList getAnnotationList​(String identifier, String name, String canvasId)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      default de.digitalcollections.iiif.model.sharedcanvas.Canvas getCanvas​(String manifestId, String canvasUri)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      default de.digitalcollections.iiif.model.sharedcanvas.Canvas getCanvas​(String manifestId, URI canvasUri)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      de.digitalcollections.iiif.model.sharedcanvas.Collection getCollection​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      default Instant getCollectionModificationDate​(String identifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      de.digitalcollections.iiif.model.sharedcanvas.Manifest getManifest​(String identifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      default Instant getManifestModificationDate​(String identifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      default de.digitalcollections.iiif.model.sharedcanvas.Range getRange​(String manifestId, String rangeUri)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      default de.digitalcollections.iiif.model.sharedcanvas.Range getRange​(String manifestId, URI rangeUri)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      default de.digitalcollections.iiif.model.sharedcanvas.Sequence getSequence​(String manifestId, String sequenceUri)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      default de.digitalcollections.iiif.model.sharedcanvas.Sequence getSequence​(String manifestId, URI sequenceUri)
      Deprecated, for removal: This API element is subject to removal in a future version.
       

    • 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 - if no collection found or access disallowed
        de.digitalcollections.model.exception.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.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 - if no manifest found or access disallowed
        de.digitalcollections.model.exception.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.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

      • getCanvas

        default de.digitalcollections.iiif.model.sharedcanvas.Canvas getCanvas​(String manifestId,
                                                                       URI canvasUri)
                                                                throws ResolvingException,
                                                                       de.digitalcollections.model.exception.ResourceNotFoundException,
                                                                       InvalidDataException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Throws:
        ResolvingException
        de.digitalcollections.model.exception.ResourceNotFoundException
        InvalidDataException

      • getRange

        default de.digitalcollections.iiif.model.sharedcanvas.Range getRange​(String manifestId,
                                                                     URI rangeUri)
                                                              throws ResolvingException,
                                                                     de.digitalcollections.model.exception.ResourceNotFoundException,
                                                                     InvalidDataException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Throws:
        ResolvingException
        de.digitalcollections.model.exception.ResourceNotFoundException
        InvalidDataException

      • getSequence

        default de.digitalcollections.iiif.model.sharedcanvas.Sequence getSequence​(String manifestId,
                                                                           String sequenceUri)
                                                                    throws ResolvingException,
                                                                           de.digitalcollections.model.exception.ResourceNotFoundException,
                                                                           InvalidDataException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Throws:
        ResolvingException
        de.digitalcollections.model.exception.ResourceNotFoundException
        InvalidDataException

      • getSequence

        default de.digitalcollections.iiif.model.sharedcanvas.Sequence getSequence​(String manifestId,
                                                                           URI sequenceUri)
                                                                    throws ResolvingException,
                                                                           de.digitalcollections.model.exception.ResourceNotFoundException,
                                                                           InvalidDataException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Throws:
        ResolvingException
        de.digitalcollections.model.exception.ResourceNotFoundException
        InvalidDataException

      • copyAttributionInfo

        default <T extends de.digitalcollections.iiif.model.sharedcanvas.Resource> T copyAttributionInfo​(de.digitalcollections.iiif.model.sharedcanvas.Manifest manifest,
                                                                                                 T res)
        Deprecated, for removal: This API element is subject to removal in a future version.