com.haulmont.cuba.gui.model

Interface KeyValueCollectionLoader

All Superinterfaces:

BaseCollectionLoader, DataLoader

All Known Implementing Classes:

KeyValueCollectionLoaderImpl

@InstallSubject(value="loadDelegate")
public interface KeyValueCollectionLoader
extends BaseCollectionLoader

Loader of KeyValueEntity collections.

Method Summary

Modifier and Type	Method and Description
ValueLoadContext	createLoadContext() Returns ValueLoadContext which is created by the parameters of this loader.
KeyValueCollectionContainer	getContainer() Returns the container which accepts loaded entities.
java.util.function.Function<ValueLoadContext,java.util.Collection<KeyValueEntity>>	getDelegate() Returns a function which will be used to load data instead of standard implementation.
java.lang.String	getStoreName() Returns data store name.
void	setContainer(KeyValueCollectionContainer container) Sets the container which accepts loaded entities.
void	setLoadDelegate(java.util.function.Function<ValueLoadContext,java.util.Collection<KeyValueEntity>> delegate) Sets a function which will be used to load data instead of standard implementation.
void	setStoreName(java.lang.String name) Sets the data store name.

Methods inherited from interface com.haulmont.cuba.gui.model.BaseCollectionLoader

getFirstResult, getMaxResults, getSort, setFirstResult, setMaxResults, setSort

Methods inherited from interface com.haulmont.cuba.gui.model.DataLoader

getCondition, getDataContext, getParameter, getParameters, getQuery, isSoftDeletion, load, removeParameter, setCondition, setDataContext, setParameter, setParameters, setQuery, setSoftDeletion

Method Detail

getContainer

KeyValueCollectionContainer getContainer()

Returns the container which accepts loaded entities.

Specified by:

getContainer in interface BaseCollectionLoader

Specified by:

getContainer in interface DataLoader

setContainer

void setContainer(KeyValueCollectionContainer container)

Sets the container which accepts loaded entities.

createLoadContext

ValueLoadContext createLoadContext()

Returns ValueLoadContext which is created by the parameters of this loader. The ValueLoadContext can be used with DataManager to load data by the same conditions.

getStoreName

java.lang.String getStoreName()

Returns data store name.

setStoreName

void setStoreName(java.lang.String name)

Sets the data store name. By default, the main data store is used.

getDelegate

java.util.function.Function<ValueLoadContext,java.util.Collection<KeyValueEntity>> getDelegate()

Returns a function which will be used to load data instead of standard implementation.

setLoadDelegate

void setLoadDelegate(java.util.function.Function<ValueLoadContext,java.util.Collection<KeyValueEntity>> delegate)

Sets a function which will be used to load data instead of standard implementation.