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

Class ItemsAPIController

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.item.Item,CudamiItemsClient>

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

@RestController
public class ItemsAPIController
extends AbstractEntitiesController<de.digitalcollections.model.identifiable.entity.item.Item,CudamiItemsClient>

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

Method Summary

Modifier and Type	Method	Description
BTResponse<de.digitalcollections.model.identifiable.entity.item.Item>	find(int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage)
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.item.Item>	findEmbeddedItems(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

doForward, 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

ItemsAPIController

public ItemsAPIController(LanguageService languageService,
 CudamiClient client)

Method Details

find

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

findDigitalObjects

@GetMapping("/api/items/{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

findEmbeddedItems

@GetMapping("/api/items/{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.item.Item> findEmbeddedItems(@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