Package io.goobi.viewer.api.rest.v1.records

Class ChangeDiscoveryResource

java.lang.Object

io.goobi.viewer.api.rest.v1.records.ChangeDiscoveryResource

@Path("/records/changes")
public class ChangeDiscoveryResource
extends Object

Author:

florian

Constructor Summary

Constructors

Constructor	Description
ChangeDiscoveryResource()

Method Summary

Modifier and Type	Method	Description
de.intranda.api.iiif.discovery.OrderedCollection<de.intranda.api.iiif.discovery.Activity>	getAllChanges(String startDate, String filterQuery)	Provides a view of the entire list of all activities by linking to the first and last page of the collection.
de.intranda.api.iiif.discovery.OrderedCollectionPage<de.intranda.api.iiif.discovery.Activity>	getPage(int pageNo, String startDate, String filterQuery)	Provides a partial list of Activities along with links to the preceding and succeeding page as well as the parent collection as provided by /iiif/discovery/activities/.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ChangeDiscoveryResource

public ChangeDiscoveryResource()

Method Details

getAllChanges

@GET
@Produces("application/json")
public de.intranda.api.iiif.discovery.OrderedCollection<de.intranda.api.iiif.discovery.Activity> getAllChanges(@QueryParam("start")
 String startDate,
 @QueryParam("filter")
 String filterQuery)
                                                                                                        throws PresentationException,
IndexUnreachableException

Provides a view of the entire list of all activities by linking to the first and last page of the collection. The pages contain the actual activity entries and are provided by /iiif/discovery/activities/<pageNo>/. This resource also contains a count of the total number of activities

Parameters:

startDate - If not null, must have the form 'yyyy-MM-dd'. Then only activities at or after this date will be listed

filterQuery - If not null or empty, must be a valid SOLR query string which is used to filter the results

Returns:

An OrderedCollection of Activities

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getPage

@GET
@Path("/{pageNo}")
@Produces("application/json")
public de.intranda.api.iiif.discovery.OrderedCollectionPage<de.intranda.api.iiif.discovery.Activity> getPage(@PathParam("pageNo")
 int pageNo,
 @QueryParam("start")
 String startDate,
 @QueryParam("filter")
 String filterQuery)
                                                                                                      throws PresentationException,
IndexUnreachableException

Provides a partial list of Activities along with links to the preceding and succeeding page as well as the parent collection as provided by /iiif/discovery/activities/. The number of Activities on the page is determined by Configuration#getIIIFDiscoveryAvtivitiesPerPage()

Parameters:

pageNo - The page number, starting with 0

startDate - If not null, must have the form 'yyyy-MM-dd'. Then only activities at or after this date will be listed

filterQuery - If not null or empty, must be a valid SOLR query string which is used to filter the results

Returns:

An OrderedCollectionPage of Activities

Throws:

PresentationException - if any.

IndexUnreachableException - if any.