Package io.jmix.ui.model

Interface KeyValueContainer

All Superinterfaces:

InstanceContainer<KeyValueEntity>

All Known Subinterfaces:

KeyValueCollectionContainer

All Known Implementing Classes:

KeyValueCollectionContainerImpl, KeyValueContainerImpl

public interface KeyValueContainer
extends InstanceContainer<KeyValueEntity>

Container for a single KeyValueEntity instance.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.model.InstanceContainer

InstanceContainer.ItemChangeEvent<T>, InstanceContainer.ItemPropertyChangeEvent<T>

Method Summary

Modifier and Type	Method	Description
KeyValueContainer	addProperty(String name)	Adds a string property to the meta-class of this loader.
KeyValueContainer	addProperty(String name, Datatype datatype)	Adds a property of the given datatype to the meta-class of this loader.
KeyValueContainer	addProperty(String name, Class aClass)	Adds a property of the given Java class to the meta-class of this loader.
KeyValueEntity	createEntity()	Creates new KeyValueEntity instance initialized with idName and instanceMetaClass defined for the data container.
String	getIdName()	Returns the name of a property that represents the entity id.
KeyValueContainer	setIdName(String name)	Sets the name of a property that represents the entity id.

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

addItemChangeListener, addItemPropertyChangeListener, getEntityMetaClass, getFetchPlan, getItem, getItemOrNull, getView, mute, setFetchPlan, setItem, setView, unmute

Method Details

setIdName

KeyValueContainer setIdName(String name)

Sets the name of a property that represents the entity id.

Returns:

this instance for chaining

getIdName

@Nullable
String getIdName()

Returns the name of a property that represents the entity id.

addProperty

KeyValueContainer addProperty(String name)

Adds a string property to the meta-class of this loader.

Returns:

this instance for chaining

addProperty

KeyValueContainer addProperty(String name,
 Class aClass)

Adds a property of the given Java class to the meta-class of this loader. The Java class can be an entity or a datatype.

Returns:

this instance for chaining

addProperty

KeyValueContainer addProperty(String name,
 Datatype datatype)

Adds a property of the given datatype to the meta-class of this loader.

Returns:

this instance for chaining

createEntity

KeyValueEntity createEntity()

Creates new KeyValueEntity instance initialized with idName and instanceMetaClass defined for the data container.