Package io.jmix.ui.model

Interface KeyValueCollectionLoader

All Superinterfaces:

BaseCollectionLoader, DataLoader

All Known Implementing Classes:

KeyValueCollectionLoaderImpl

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

Loader of KeyValueEntity collections.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	KeyValueCollectionLoader.PostLoadEvent	Event sent after successful loading of entities and setting to the container.
static class	KeyValueCollectionLoader.PreLoadEvent	Event sent before loading entities.

Method Summary

Modifier and Type	Method	Description
Subscription	addPostLoadListener(Consumer<KeyValueCollectionLoader.PostLoadEvent> listener)	Adds a listener to KeyValueCollectionLoader.PostLoadEvent.
Subscription	addPreLoadListener(Consumer<KeyValueCollectionLoader.PreLoadEvent> listener)	Adds a listener to KeyValueCollectionLoader.PreLoadEvent.
ValueLoadContext	createLoadContext()	Returns ValueLoadContext which is created by the parameters of this loader.
KeyValueCollectionContainer	getContainer()	Returns the container which accepts loaded entities.
Function<ValueLoadContext,List<KeyValueEntity>>	getDelegate()	Returns a function which will be used to load data instead of standard implementation.
String	getStoreName()	Returns data store name.
void	setContainer(KeyValueCollectionContainer container)	Sets the container which accepts loaded entities.
void	setLoadDelegate(Function<ValueLoadContext,List<KeyValueEntity>> delegate)	Sets a function which will be used to load data instead of standard implementation.
void	setStoreName(String name)	Sets the data store name.

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

getFirstResult, getMaxResults, getSort, setFirstResult, setMaxResults, setSort

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

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

String getStoreName()

Returns data store name.

setStoreName

void setStoreName(@Nullable
 String name)

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

getDelegate

Function<ValueLoadContext,List<KeyValueEntity>> getDelegate()

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

setLoadDelegate

void setLoadDelegate(Function<ValueLoadContext,List<KeyValueEntity>> delegate)

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

addPreLoadListener

Subscription addPreLoadListener(Consumer<KeyValueCollectionLoader.PreLoadEvent> listener)

Adds a listener to KeyValueCollectionLoader.PreLoadEvent.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe(id = "fooDl", target = Target.DATA_LOADER)
     private void onFooDlPreLoad(KeyValueCollectionLoader.PreLoadEvent event) {
         // handle event here
     }
 

Parameters:

listener - listener

Returns:

subscription

addPostLoadListener

Subscription addPostLoadListener(Consumer<KeyValueCollectionLoader.PostLoadEvent> listener)

Adds a listener to KeyValueCollectionLoader.PostLoadEvent.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe(id = "fooDl", target = Target.DATA_LOADER)
     private void onFooDlPostLoad(KeyValueCollectionLoader.PostLoadEvent event) {
         // handle event here
     }
 

Parameters:

listener - listener

Returns:

subscription