Package io.jmix.ui.model

Interface BaseCollectionLoader

All Superinterfaces:

DataLoader

All Known Subinterfaces:

CollectionLoader<E>, KeyValueCollectionLoader

All Known Implementing Classes:

CollectionLoaderImpl, KeyValueCollectionLoaderImpl

public interface BaseCollectionLoader
extends DataLoader

Root interface of collection loaders.

See Also:

• CollectionLoader
• KeyValueCollectionLoader

Method Summary

Modifier and Type	Method	Description
CollectionContainer	getContainer()	Returns the container which accepts loaded entities.
int	getFirstResult()	The position of the first instance to load, numbered from 0.
int	getMaxResults()	The maximum number of instances to load.
Sort	getSort()	Returns the sort object which is used when loading.
void	setFirstResult(int firstResult)	Sets the position of the first instance to load, numbered from 0.
void	setMaxResults(int maxResults)	Sets the maximum number of instances to load.
void	setSort(Sort sort)	Sets the sort object which is used when loading.

Methods inherited from interface io.jmix.ui.model.DataLoader

getCondition, getDataContext, getHints, getParameter, getParameters, getQuery, load, removeParameter, setCondition, setDataContext, setHint, setParameter, setParameters, setQuery

Method Details

getContainer

CollectionContainer getContainer()

Returns the container which accepts loaded entities.

Specified by:

getContainer in interface DataLoader

getFirstResult

int getFirstResult()

The position of the first instance to load, numbered from 0. Returns 0 if setFirstResult(int) was not called.

setFirstResult

void setFirstResult(int firstResult)

Sets the position of the first instance to load, numbered from 0.

getMaxResults

int getMaxResults()

The maximum number of instances to load. Returns Integer.MAX_VALUE if setMaxResults(int) was not called.

setMaxResults

void setMaxResults(int maxResults)

Sets the maximum number of instances to load.

getSort

@Nullable
Sort getSort()

Returns the sort object which is used when loading.

setSort

void setSort(@Nullable
 Sort sort)

Sets the sort object which is used when loading.