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

Class ArticleController

java.lang.Object

de.digitalcollections.cudami.server.controller.AbstractPagingAndSortingController

de.digitalcollections.cudami.server.controller.AbstractUniqueObjectController<T>

de.digitalcollections.cudami.server.controller.identifiable.AbstractIdentifiableController<de.digitalcollections.model.identifiable.entity.Article>

de.digitalcollections.cudami.server.controller.identifiable.entity.ArticleController

@RestController
public class ArticleController
extends AbstractIdentifiableController<de.digitalcollections.model.identifiable.entity.Article>

Field Summary

Fields inherited from class de.digitalcollections.cudami.server.controller.AbstractUniqueObjectController

LOGGER

Constructor Summary

Constructors

Constructor	Description
ArticleController(ArticleService articleService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity	addCreators(UUID articleUuid, List<de.digitalcollections.model.identifiable.entity.agent.Agent> creators)
long	count()
de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Article>	find(int pageNumber, int pageSize, List<de.digitalcollections.model.list.sorting.Order> sortBy, List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria, de.digitalcollections.model.list.filtering.Filtering filtering)
org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.entity.Article>	getByUuid(UUID uuid, Locale pLocale)
List<Locale>	getLanguages()
protected IdentifiableService<de.digitalcollections.model.identifiable.entity.Article>	getService()
org.springframework.http.ResponseEntity	removeCreator(UUID articleUuid, UUID agentUuid)
de.digitalcollections.model.identifiable.entity.Article	save(de.digitalcollections.model.identifiable.entity.Article article, org.springframework.validation.BindingResult errors)
de.digitalcollections.model.identifiable.entity.Article	update(UUID uuid, de.digitalcollections.model.identifiable.entity.Article article, org.springframework.validation.BindingResult errors)

Methods inherited from class de.digitalcollections.cudami.server.controller.identifiable.AbstractIdentifiableController

extractNamespaceAndId, getByIdentifier

Methods inherited from class de.digitalcollections.cudami.server.controller.AbstractUniqueObjectController

buildExampleWithUuid, delete, delete, getByUuid, getByUuidAndLocale

Methods inherited from class de.digitalcollections.cudami.server.controller.AbstractPagingAndSortingController

createPageRequest, getFieldType, mergeFilters

Methods inherited from class java.lang.Object

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

Constructor Details

ArticleController

public ArticleController(ArticleService articleService)

Method Details

addCreators

@PostMapping(value="/v6/articles/{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}$}/creators",
             produces="application/json")
public org.springframework.http.ResponseEntity addCreators(@PathVariable("uuid")
 UUID articleUuid,
 @RequestBody
 List<de.digitalcollections.model.identifiable.entity.agent.Agent> creators)
                                                    throws ServiceException

Throws:

ServiceException

count

@GetMapping(value={"/v6/articles/count","/v5/articles/count","/v2/articles/count","/latest/articles/count"},
            produces="application/json")
public long count()
           throws ServiceException

Overrides:

count in class AbstractUniqueObjectController<de.digitalcollections.model.identifiable.entity.Article>

Throws:

ServiceException

find

@GetMapping(value="/v6/articles",
            produces="application/json")
public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Article> find(@RequestParam(name="pageNumber",required=false,defaultValue="0")
 int pageNumber,
 @RequestParam(name="pageSize",required=false,defaultValue="25")
 int pageSize,
 @RequestParam(name="sortBy",required=false)
 List<de.digitalcollections.model.list.sorting.Order> sortBy,
 @RequestParam(name="filter",required=false)
 List<de.digitalcollections.model.list.filtering.FilterCriterion> filterCriteria,
 @RequestParam(name="filtering",required=false)
 de.digitalcollections.model.list.filtering.Filtering filtering)
                                                                                                                   throws ServiceException

Overrides:

find in class AbstractUniqueObjectController<de.digitalcollections.model.identifiable.entity.Article>

Throws:

ServiceException

getByUuid

@GetMapping(value={"/v6/articles/{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}$}","/v5/articles/{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}$}","/v2/articles/{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}$}","/latest/articles/{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}$}"},
            produces="application/json")
public org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.entity.Article> getByUuid(@PathVariable("uuid")
 UUID uuid,
 @RequestParam(name="pLocale",required=false)
 Locale pLocale)
                                                                                                           throws ServiceException

Throws:

ServiceException

getLanguages

@GetMapping(value={"/v6/articles/languages","/v5/articles/languages","/v2/articles/languages","/latest/articles/languages"},
            produces="application/json")
public List<Locale> getLanguages()
                          throws ServiceException

Overrides:

getLanguages in class AbstractIdentifiableController<de.digitalcollections.model.identifiable.entity.Article>

Throws:

ServiceException

getService

protected IdentifiableService<de.digitalcollections.model.identifiable.entity.Article> getService()

Specified by:

getService in class AbstractIdentifiableController<de.digitalcollections.model.identifiable.entity.Article>

removeCreator

@DeleteMapping(value="/v6/articles/{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}$}/creators/{agentUuid}",
               produces="application/json")
public org.springframework.http.ResponseEntity removeCreator(@PathVariable("uuid")
 UUID articleUuid,
 @PathVariable("agentUuid")
 UUID agentUuid)
                                                      throws ServiceException

Throws:

ServiceException

save

@PostMapping(value={"/v6/articles","/v5/articles","/v2/articles","/latest/articles"},
             produces="application/json")
public de.digitalcollections.model.identifiable.entity.Article save(@RequestBody
 de.digitalcollections.model.identifiable.entity.Article article,
 org.springframework.validation.BindingResult errors)
                                                             throws ServiceException,
ValidationException

Overrides:

save in class AbstractUniqueObjectController<de.digitalcollections.model.identifiable.entity.Article>

Throws:

ServiceException

ValidationException

update

@PutMapping(value={"/v6/articles/{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}$}","/v5/articles/{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}$}","/v2/articles/{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}$}","/latest/articles/{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}$}"},
            produces="application/json")
public de.digitalcollections.model.identifiable.entity.Article update(@PathVariable
 UUID uuid,
 @RequestBody
 de.digitalcollections.model.identifiable.entity.Article article,
 org.springframework.validation.BindingResult errors)
                                                               throws ServiceException,
ValidationException

Overrides:

update in class AbstractUniqueObjectController<de.digitalcollections.model.identifiable.entity.Article>

Throws:

ServiceException

ValidationException