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 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, String sortField, de.digitalcollections.model.api.paging.enums.Direction sortDirection, de.digitalcollections.model.api.paging.enums.NullHandling nullHandling, String searchTerm)
List<de.digitalcollections.model.api.identifiable.Identifiable>	find(String searchTerm, int maxResults)
de.digitalcollections.model.api.identifiable.Identifiable	findById(UUID uuid)
org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.Identifiable>	getByIdentifier(String namespace, String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentifiableController

public IdentifiableController()

Method Detail

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="sortField",required=false,defaultValue="uuid")
                                                                                                                                 String sortField,
                                                                                                                                 @RequestParam(name="sortDirection",required=false,defaultValue="ASC")
                                                                                                                                 de.digitalcollections.model.api.paging.enums.Direction sortDirection,
                                                                                                                                 @RequestParam(name="nullHandling",required=false,defaultValue="NATIVE")
                                                                                                                                 de.digitalcollections.model.api.paging.enums.NullHandling nullHandling,
                                                                                                                                 @RequestParam(name="searchTerm",required=false)
                                                                                                                                 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 List<de.digitalcollections.model.api.identifiable.Identifiable> find(@RequestParam(name="searchTerm")
                                                                            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
                                                                          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
                                                                                                                          String namespace,
                                                                                                                          @PathVariable
                                                                                                                          String id)
                                                                                                                   throws IdentifiableServiceException

Throws:

IdentifiableServiceException