de.digitalcollections.iiif.presentation.business.api.v2

Interface PresentationService

public interface PresentationService

Service for IIIF Presentation API functionality.

Method Summary

Modifier and Type	Method and Description
default Canvas	getCanvas(String manifestId, String canvasUri)
Canvas	getCanvas(String manifestId, URI canvasUri)
Collection	getCollection(String name)
Manifest	getManifest(String identifier)
default Range	getRange(String manifestId, String rangeUri)
Range	getRange(String manifestId, URI rangeUri)
default Sequence	getSequence(String manifestId, String sequenceUri)
Sequence	getSequence(String manifestId, URI sequenceUri)

Method Detail

getCollection

Collection getCollection(String name)
                  throws NotFoundException,
                         InvalidDataException

Parameters:

name - unique name of collection

Returns:

Collection specified by name

Throws:

NotFoundException - if no collection found or access disallowed

InvalidDataException

getManifest

Manifest getManifest(String identifier)
              throws NotFoundException,
                     InvalidDataException

Parameters:

identifier - unique id for IIIF resource

Returns:

Manifest specifying presentation for IIIF resource

Throws:

NotFoundException - if no manifest found or access disallowed

InvalidDataException

getCanvas

default Canvas getCanvas(String manifestId,
                         String canvasUri)
                  throws NotFoundException,
                         InvalidDataException

Throws:

NotFoundException

InvalidDataException

getCanvas

Canvas getCanvas(String manifestId,
                 URI canvasUri)
          throws NotFoundException,
                 InvalidDataException

Throws:

NotFoundException

InvalidDataException

getRange

default Range getRange(String manifestId,
                       String rangeUri)
                throws NotFoundException,
                       InvalidDataException

Throws:

NotFoundException

InvalidDataException

getRange

Range getRange(String manifestId,
               URI rangeUri)
        throws NotFoundException,
               InvalidDataException

Throws:

NotFoundException

InvalidDataException

getSequence

default Sequence getSequence(String manifestId,
                             String sequenceUri)
                      throws NotFoundException,
                             InvalidDataException

Throws:

NotFoundException

InvalidDataException

getSequence

Sequence getSequence(String manifestId,
                     URI sequenceUri)
              throws NotFoundException,
                     InvalidDataException

Throws:

NotFoundException

InvalidDataException