pro.taskana

Interface BaseQuery<T>

Type Parameters:

T - specifies the return type of the follwing methods

All Known Subinterfaces:

ClassificationQuery, ObjectReferenceQuery, TaskQuery, WorkbasketQuery

All Known Implementing Classes:

ClassificationQueryImpl, ObjectReferenceQueryImpl, TaskQueryImpl, WorkbasketQueryImpl

public interface BaseQuery<T>

Main query interface.

Author:

EH

Method Summary

Modifier and Type	Method and Description
long	count() Counting the amount of rows/results for the current query.
List<T>	list() This method will return a list of defined T objects.
List<T>	list(int offset, int limit) This method will return a list of defined T objects with specified offset and an limit.
default List<T>	listPage(int pageNumber, int pageSize) This method will return all results for page X with a size of Y of the current query. Negative pageNumber/size will be changed to 0 and the last page got maybe less elements.
T	single() This method will return a single object of T.

Method Detail

list

List<T> list()
      throws NotAuthorizedException

This method will return a list of defined T objects.

Returns:

List containing elements of type T

Throws:

NotAuthorizedException - if the user is not authorized to perform this query

list

List<T> list(int offset,
             int limit)
      throws NotAuthorizedException

This method will return a list of defined T objects with specified offset and an limit.

Parameters:

offset - index of the first element which should be returned.

limit - number of elements which should be returned beginning with offset.

Returns:

List containing elements of type T

Throws:

NotAuthorizedException - if the user is not authorized to perform this query

listPage

default List<T> listPage(int pageNumber,
                         int pageSize)
                  throws NotAuthorizedException

This method will return all results for page X with a size of Y of the current query.
Negative pageNumber/size will be changed to 0 and the last page got maybe less elements.

Parameters:

pageNumber - current pagination page starting at 0.

pageSize - amount of elements for this page.

Returns:

resulList for the current query starting at X and returning max Y elements.

Throws:

NotAuthorizedException - if the user is not authorized to perform this query

single

T single()
  throws NotAuthorizedException

This method will return a single object of T.

Returns:

T a single object of given Type.

Throws:

NotAuthorizedException - if the user is not authorized to perform this query

count

long count()
    throws NotAuthorizedException

Counting the amount of rows/results for the current query. This can be used for a pagination afterwards.

Returns:

resultRowCount

Throws:

NotAuthorizedException - when permissions not granted.