Package de.digitalcollections.cudami.admin.controller.identifiable.entity.work

Class WorksAPIController

java.lang.Object

de.digitalcollections.commons.springmvc.controller.AbstractController

de.digitalcollections.cudami.admin.controller.AbstractPagingAndSortingController

de.digitalcollections.cudami.admin.controller.AbstractUniqueObjectController<I>

de.digitalcollections.cudami.admin.controller.identifiable.AbstractIdentifiablesController<E,C>

de.digitalcollections.cudami.admin.controller.identifiable.entity.AbstractEntitiesController<de.digitalcollections.model.identifiable.entity.work.Work,CudamiWorksClient>

de.digitalcollections.cudami.admin.controller.identifiable.entity.work.WorksAPIController

@RestController
public class WorksAPIController
extends AbstractEntitiesController<de.digitalcollections.model.identifiable.entity.work.Work,CudamiWorksClient>

Controller for all public "Works" endpoints (API).

Field Summary

Fields inherited from class de.digitalcollections.cudami.admin.controller.AbstractUniqueObjectController

service

Fields inherited from class de.digitalcollections.cudami.admin.controller.AbstractPagingAndSortingController

languageService

Constructor Summary

Constructors

Constructor	Description
WorksAPIController(CudamiClient client, LanguageService languageService)

Method Summary

Modifier and Type	Method	Description
BTResponse<de.digitalcollections.model.identifiable.entity.work.Work>	find(int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage)
BTResponse<de.digitalcollections.model.identifiable.entity.work.Work>	findChildWorks(UUID uuid, int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage)
BTResponse<de.digitalcollections.model.identifiable.entity.manifestation.Manifestation>	findManifestations(UUID uuid, int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage)

Methods inherited from class de.digitalcollections.cudami.admin.controller.identifiable.entity.AbstractEntitiesController

search

Methods inherited from class de.digitalcollections.cudami.admin.controller.identifiable.AbstractIdentifiablesController

getExistingLanguagesFromIdentifiable, getExistingLanguagesFromIdentifiables, getExistingLanguagesFromService

Methods inherited from class de.digitalcollections.cudami.admin.controller.AbstractUniqueObjectController

find

Methods inherited from class de.digitalcollections.cudami.admin.controller.AbstractPagingAndSortingController

createBTRequest, createPageRequest, createPageRequest, getDataLanguage, getDataLanguage, getFieldType

Methods inherited from class de.digitalcollections.commons.springmvc.controller.AbstractController

verifyBinding

Methods inherited from class java.lang.Object

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

Constructor Details

WorksAPIController

public WorksAPIController(CudamiClient client,
 LanguageService languageService)

Method Details

find

@GetMapping("/api/works")
@ResponseBody
public BTResponse<de.digitalcollections.model.identifiable.entity.work.Work> find(@RequestParam(name="offset",required=false,defaultValue="0")
 int offset,
 @RequestParam(name="limit",required=false,defaultValue="10")
 int limit,
 @RequestParam(name="search",required=false)
 String searchTerm,
 @RequestParam(name="sort",required=false,defaultValue="label")
 String sortProperty,
 @RequestParam(name="order",required=false,defaultValue="asc")
 String sortOrder,
 @RequestParam(name="dataLanguage",required=false)
 String dataLanguage)
                                                                           throws de.digitalcollections.model.exception.TechnicalException,
ServiceException

Throws:

de.digitalcollections.model.exception.TechnicalException

ServiceException

findChildWorks

@GetMapping("/api/works/{uuid:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$}/children")
@ResponseBody
public BTResponse<de.digitalcollections.model.identifiable.entity.work.Work> findChildWorks(@PathVariable
 UUID uuid,
 @RequestParam(name="offset",required=false,defaultValue="0")
 int offset,
 @RequestParam(name="limit",required=false,defaultValue="10")
 int limit,
 @RequestParam(name="search",required=false)
 String searchTerm,
 @RequestParam(name="sort",required=false,defaultValue="label")
 String sortProperty,
 @RequestParam(name="order",required=false,defaultValue="asc")
 String sortOrder,
 @RequestParam(name="dataLanguage",required=false)
 String dataLanguage)
                                                                                     throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

findManifestations

@GetMapping("/api/works/{uuid:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$}/manifestations")
@ResponseBody
public BTResponse<de.digitalcollections.model.identifiable.entity.manifestation.Manifestation> findManifestations(@PathVariable
 UUID uuid,
 @RequestParam(name="offset",required=false,defaultValue="0")
 int offset,
 @RequestParam(name="limit",required=false,defaultValue="10")
 int limit,
 @RequestParam(name="search",required=false)
 String searchTerm,
 @RequestParam(name="sort",required=false,defaultValue="label")
 String sortProperty,
 @RequestParam(name="order",required=false,defaultValue="asc")
 String sortOrder,
 @RequestParam(name="dataLanguage",required=false)
 String dataLanguage)
                                                                                                           throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException