Package pro.taskana.common.rest

Class AbstractPagingController

java.lang.Object

pro.taskana.common.rest.AbstractPagingController

Direct Known Subclasses:

ClassificationController, TaskController, WorkbasketAccessItemController, WorkbasketController

public abstract class AbstractPagingController
extends Object

Abstract superclass for taskana REST controller with pageable resources.

Constructor Summary

Constructors

Constructor	Description
AbstractPagingController()

Method Summary

Modifier and Type	Method	Description
protected String[]	extractCommaSeparatedFields(List<String> list)
protected org.springframework.hateoas.PagedModel.PageMetadata	getPageMetadata(org.springframework.util.MultiValueMap<String,String> params, pro.taskana.common.api.BaseQuery<?,?> query)
protected <T> List<T>	getQueryList(pro.taskana.common.api.BaseQuery<T,?> query, org.springframework.hateoas.PagedModel.PageMetadata pageMetadata)
protected org.springframework.hateoas.PagedModel.PageMetadata	initPageMetadata(String pagesizeParam, String pageParam, long totalElements)
protected org.springframework.hateoas.PagedModel.PageMetadata	initPageMetadata(org.springframework.util.MultiValueMap<String,String> param, long totalElements)
protected void	validateNoInvalidParameterIsLeft(org.springframework.util.MultiValueMap<String,String> params)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPagingController

public AbstractPagingController()

Method Detail

extractCommaSeparatedFields

protected String[] extractCommaSeparatedFields(List<String> list)

validateNoInvalidParameterIsLeft

protected void validateNoInvalidParameterIsLeft(org.springframework.util.MultiValueMap<String,String> params)
                                         throws pro.taskana.common.api.exceptions.InvalidArgumentException

Throws:

pro.taskana.common.api.exceptions.InvalidArgumentException

getPageMetadata

protected org.springframework.hateoas.PagedModel.PageMetadata getPageMetadata(org.springframework.util.MultiValueMap<String,String> params,
                                                                              pro.taskana.common.api.BaseQuery<?,?> query)
                                                                       throws pro.taskana.common.api.exceptions.InvalidArgumentException

Throws:

pro.taskana.common.api.exceptions.InvalidArgumentException

getQueryList

protected <T> List<T> getQueryList(pro.taskana.common.api.BaseQuery<T,?> query,
                                   org.springframework.hateoas.PagedModel.PageMetadata pageMetadata)

initPageMetadata

protected org.springframework.hateoas.PagedModel.PageMetadata initPageMetadata(org.springframework.util.MultiValueMap<String,String> param,
                                                                               long totalElements)
                                                                        throws pro.taskana.common.api.exceptions.InvalidArgumentException

Throws:

pro.taskana.common.api.exceptions.InvalidArgumentException

initPageMetadata

protected org.springframework.hateoas.PagedModel.PageMetadata initPageMetadata(String pagesizeParam,
                                                                               String pageParam,
                                                                               long totalElements)
                                                                        throws pro.taskana.common.api.exceptions.InvalidArgumentException

Throws:

pro.taskana.common.api.exceptions.InvalidArgumentException