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

Class CollectionsAPIController

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.Collection,CudamiCollectionsClient>

de.digitalcollections.cudami.admin.controller.identifiable.entity.CollectionsAPIController

@RestController
public class CollectionsAPIController
extends AbstractEntitiesController<de.digitalcollections.model.identifiable.entity.Collection,CudamiCollectionsClient>

Controller for all public "Collections" 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
CollectionsAPIController(CudamiClient client, LanguageService languageService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity	addDigitalObjects(UUID uuid, List<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> digitalObjects)
org.springframework.http.ResponseEntity	addSubcollection(UUID collectionUuid, UUID subcollectionUuid)
org.springframework.http.ResponseEntity	addSubcollections(UUID collectionUuid, List<de.digitalcollections.model.identifiable.entity.Collection> subcollections)
de.digitalcollections.model.identifiable.entity.Collection	create()
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection>	find(int pageNumber, int pageSize, String searchField, String searchTerm, List<de.digitalcollections.model.list.sorting.Order> sortBy)
BTResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>	findDigitalObjects(UUID uuid, int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage)
BTResponse<de.digitalcollections.model.identifiable.entity.Collection>	findSubcollections(UUID uuid, int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage)
BTResponse<de.digitalcollections.model.identifiable.entity.Collection>	findTop(int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage)
de.digitalcollections.model.identifiable.entity.Collection	getByIdentifier(String namespace, String id)
de.digitalcollections.model.identifiable.entity.Collection	getByRefId(long refId)
de.digitalcollections.model.identifiable.entity.Collection	getByUuid(UUID uuid)
org.springframework.http.ResponseEntity	removeDigitalObject(UUID collectionUuid, UUID digitalobjectUuid)
org.springframework.http.ResponseEntity	removeSubcollection(UUID collectionUuid, UUID subcollectionUuid)
org.springframework.http.ResponseEntity	save(de.digitalcollections.model.identifiable.entity.Collection collection, String parentType, UUID parentUuid)
org.springframework.http.ResponseEntity	update(UUID uuid, de.digitalcollections.model.identifiable.entity.Collection collection)

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

CollectionsAPIController

public CollectionsAPIController(CudamiClient client,
 LanguageService languageService)

Method Details

addDigitalObjects

@PostMapping("/api/collections/{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}$}/digitalobjects")
public org.springframework.http.ResponseEntity addDigitalObjects(@PathVariable
 UUID uuid,
 @RequestBody
 List<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> digitalObjects)
                                                          throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

addSubcollection

@PostMapping("/api/collections/{collectionUuid}/collections/{subcollectionUuid}")
public org.springframework.http.ResponseEntity addSubcollection(@PathVariable
 UUID collectionUuid,
 @PathVariable
 UUID subcollectionUuid)
                                                         throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

addSubcollections

@PostMapping("/api/collections/{collectionUuid}/collections")
public org.springframework.http.ResponseEntity addSubcollections(@PathVariable
 UUID collectionUuid,
 @RequestBody
 List<de.digitalcollections.model.identifiable.entity.Collection> subcollections)
                                                          throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

create

@GetMapping("/api/collections/new")
@ResponseBody
public de.digitalcollections.model.identifiable.entity.Collection create()
                                                                  throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

find

@GetMapping("/api/collections/search")
@ResponseBody
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> find(@RequestParam(name="pageNumber",required=false,defaultValue="0")
 int pageNumber,
 @RequestParam(name="pageSize",required=false,defaultValue="5")
 int pageSize,
 @RequestParam(name="searchField",required=false)
 String searchField,
 @RequestParam(name="searchTerm",required=false)
 String searchTerm,
 @RequestParam(name="sortBy",required=false)
 List<de.digitalcollections.model.list.sorting.Order> sortBy)
                                                                                                                      throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

findDigitalObjects

@GetMapping("/api/collections/{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}$}/digitalobjects")
@ResponseBody
public BTResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> findDigitalObjects(@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

findSubcollections

@GetMapping("/api/collections/{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}$}/collections")
@ResponseBody
public BTResponse<de.digitalcollections.model.identifiable.entity.Collection> findSubcollections(@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

findTop

@GetMapping("/api/collections")
@ResponseBody
public BTResponse<de.digitalcollections.model.identifiable.entity.Collection> findTop(@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

getByIdentifier

@GetMapping("/api/collections/identifier/{namespace}:{id}")
@ResponseBody
public de.digitalcollections.model.identifiable.entity.Collection getByIdentifier(@PathVariable
 String namespace,
 @PathVariable
 String id)
                                                                           throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

getByRefId

@GetMapping("/api/collections/{refId:[0-9]+}")
@ResponseBody
public de.digitalcollections.model.identifiable.entity.Collection getByRefId(@PathVariable
 long refId)
                                                                      throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

getByUuid

@GetMapping("/api/collections/{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}$}")
@ResponseBody
public de.digitalcollections.model.identifiable.entity.Collection getByUuid(@PathVariable
 UUID uuid)
                                                                     throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

removeDigitalObject

@DeleteMapping("/api/collections/{collectionUuid}/digitalobjects/{digitalobjectUuid}")
@ResponseBody
public org.springframework.http.ResponseEntity removeDigitalObject(@PathVariable
 UUID collectionUuid,
 @PathVariable
 UUID digitalobjectUuid)
                                                            throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

removeSubcollection

@DeleteMapping("/api/collections/{collectionUuid}/collections/{subcollectionUuid}")
public org.springframework.http.ResponseEntity removeSubcollection(@PathVariable
 UUID collectionUuid,
 @PathVariable
 UUID subcollectionUuid)
                                                            throws de.digitalcollections.model.exception.TechnicalException

Throws:

de.digitalcollections.model.exception.TechnicalException

save

@PostMapping("/api/collections")
public org.springframework.http.ResponseEntity save(@RequestBody
 de.digitalcollections.model.identifiable.entity.Collection collection,
 @RequestParam(name="parentType",required=false)
 String parentType,
 @RequestParam(name="parentUuid",required=false)
 UUID parentUuid)

update

@PutMapping("/api/collections/{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}$}")
public org.springframework.http.ResponseEntity update(@PathVariable
 UUID uuid,
 @RequestBody
 de.digitalcollections.model.identifiable.entity.Collection collection)