Class TopicsAPIController
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.Topic,CudamiTopicsClient>
de.digitalcollections.cudami.admin.controller.identifiable.entity.TopicsAPIController
@RestController
public class TopicsAPIController
extends AbstractEntitiesController<de.digitalcollections.model.identifiable.entity.Topic,CudamiTopicsClient>
Controller for all public "Topics" 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
-
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity
addEntities
(UUID uuid, List<de.digitalcollections.model.identifiable.entity.Entity> entities) org.springframework.http.ResponseEntity
addFileResources
(UUID uuid, List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources) de.digitalcollections.model.identifiable.entity.Topic
create()
BTResponse<de.digitalcollections.model.identifiable.entity.Entity>
findEntities
(UUID uuid, int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage) BTResponse<de.digitalcollections.model.identifiable.resource.FileResource>
findFileResources
(UUID uuid, int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage) BTResponse<de.digitalcollections.model.identifiable.entity.Topic>
findSubtopics
(UUID uuid, int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage) BTResponse<de.digitalcollections.model.identifiable.entity.Topic>
findTopTopics
(int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage) de.digitalcollections.model.identifiable.entity.Topic
org.springframework.http.ResponseEntity
removeEntity
(UUID topicUuid, UUID entityUuid) org.springframework.http.ResponseEntity
removeFileResource
(UUID topicUuid, UUID fileResourceUuid) org.springframework.http.ResponseEntity
org.springframework.http.ResponseEntity
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
-
Constructor Details
-
TopicsAPIController
-
-
Method Details
-
addEntities
@PostMapping("/api/topics/{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}$}/entities") public org.springframework.http.ResponseEntity addEntities(@PathVariable UUID uuid, @RequestBody List<de.digitalcollections.model.identifiable.entity.Entity> entities) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
addFileResources
@PostMapping("/api/topics/{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}$}/fileresources") public org.springframework.http.ResponseEntity addFileResources(@PathVariable UUID uuid, @RequestBody List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
create
@GetMapping("/api/topics/new") @ResponseBody public de.digitalcollections.model.identifiable.entity.Topic create() throws de.digitalcollections.model.exception.TechnicalException- Throws:
de.digitalcollections.model.exception.TechnicalException
-
findEntities
@GetMapping("/api/topics/{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}$}/entities") @ResponseBody public BTResponse<de.digitalcollections.model.identifiable.entity.Entity> findEntities(@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
-
findFileResources
@GetMapping("/api/topics/{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}$}/fileresources") @ResponseBody public BTResponse<de.digitalcollections.model.identifiable.resource.FileResource> findFileResources(@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
-
findSubtopics
@GetMapping("/api/topics/{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}$}/topics") @ResponseBody public BTResponse<de.digitalcollections.model.identifiable.entity.Topic> findSubtopics(@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
-
findTopTopics
@GetMapping("/api/topics") @ResponseBody public BTResponse<de.digitalcollections.model.identifiable.entity.Topic> findTopTopics(@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
-
getByUuid
@GetMapping("/api/topics/{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.Topic getByUuid(@PathVariable UUID uuid) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
removeEntity
@DeleteMapping("/api/topics/{topicUuid}/entities/{entityUuid}") @ResponseBody public org.springframework.http.ResponseEntity removeEntity(@PathVariable UUID topicUuid, @PathVariable UUID entityUuid) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
removeFileResource
@DeleteMapping("/api/topics/{topicUuid}/fileresources/{fileResourceUuid}") @ResponseBody public org.springframework.http.ResponseEntity removeFileResource(@PathVariable UUID topicUuid, @PathVariable UUID fileResourceUuid) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
save
@PostMapping("/api/topics") public org.springframework.http.ResponseEntity save(@RequestBody de.digitalcollections.model.identifiable.entity.Topic topic, @RequestParam(name="parentUuid",required=false) UUID parentUuid) -
update
@PutMapping("/api/topics/{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.Topic topic)
-