Package de.digitalcollections.cudami.server.controller.identifiable

Class IdentifiableController

java.lang.Object
de.digitalcollections.cudami.server.controller.identifiable.IdentifiableController
@RestController
@Api(description="The identifiable controller",
     name="Identifiable controller")
public class IdentifiableController
extends java.lang.Object

  • Constructor Summary

    Constructors
    Constructor Description
    IdentifiableController()  

  • Method Summary

    Modifier and Type Method Description
    de.digitalcollections.model.api.paging.SearchPageResponse<de.digitalcollections.model.api.identifiable.Identifiable> find​(int pageNumber, int pageSize, java.util.List<de.digitalcollections.model.api.paging.Order> sortBy, java.lang.String searchTerm)  
    java.util.List<de.digitalcollections.model.api.identifiable.Identifiable> find​(java.lang.String searchTerm, int maxResults)  
    de.digitalcollections.model.api.identifiable.Identifiable findById​(java.util.UUID uuid)  
    org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.Identifiable> getByIdentifier​(java.lang.String namespace, java.lang.String id)  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • IdentifiableController

      public IdentifiableController()

  • Method Details

    • find

      @ApiMethod(description="Find limited amount of identifiables containing searchTerm in label or description") @GetMapping(value={"/latest/identifiables/search","/v2/identifiables/search"}, produces="application/json") @ApiResponseObject public de.digitalcollections.model.api.paging.SearchPageResponse<de.digitalcollections.model.api.identifiable.Identifiable> find​(@RequestParam(name="pageNumber",required=false,defaultValue="0") int pageNumber, @RequestParam(name="pageSize",required=false,defaultValue="5") int pageSize, @RequestParam(name="sortBy",required=false) java.util.List<de.digitalcollections.model.api.paging.Order> sortBy, @RequestParam(name="searchTerm",required=false) java.lang.String searchTerm)

    • find

      @ApiMethod(description="Find limited amount of identifiables containing searchTerm in label") @GetMapping(value={"/latest/identifiables","/v2/identifiables"}, produces="application/json") @ApiResponseObject public java.util.List<de.digitalcollections.model.api.identifiable.Identifiable> find​(@RequestParam(name="searchTerm") java.lang.String searchTerm, @RequestParam(name="maxResults",required=false,defaultValue="25") int maxResults)

    • findById

      @ApiMethod(description="Get identifiable by uuid") @GetMapping(value={"/latest/identifiables/{uuid}","/v2/identifiables/{uuid}"}, produces="application/json") @ApiResponseObject public de.digitalcollections.model.api.identifiable.Identifiable findById​(@PathVariable java.util.UUID uuid)

    • getByIdentifier

      @ApiMethod(description="get an identifiable as JSON or XML, depending on extension or <tt>format</tt> request parameter or accept header") @GetMapping(value={"/latest/identifiables/identifier/{namespace}:{id}","/v2/identifiables/identifier/{namespace}:{id}"}, produces={"application/json","application/xml"}) @ApiResponseObject public org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.Identifiable> getByIdentifier​(@PathVariable java.lang.String namespace, @PathVariable java.lang.String id) throws IdentifiableServiceException
      Throws:
      IdentifiableServiceException