Package de.espirit.firstspirit.access.editor.value

Interface DatasetContainer

public interface DatasetContainer

A container for a dataset, see DatasetEditorValue. Use the "create" methods in DatasetContainer.Factory to create instances.

Since:

4.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DatasetContainer.Factory	Factory to create new DatasetContainer instances; either with an DatasetContainer.Factory.create(Entity, TableTemplate, Language entity) or a dataset.

Method Summary

Modifier and Type	Method	Description
@Nullable Dataset	getDataset()	The stored dataset - may be null
@Nullable UUID	getGid()	The gid of the entity
@Nullable KeyValue	getKey()	The key value of the entity.
Language	getLanguage()	The language for which this value is stored.
String	getTemplateUid()	The uid of the template.
boolean	isEmpty()	Shortcut for getDataset() == null.

Method Details

isEmpty

@ApiDoc(comment="Shortcut for getDataset() == null.",
        since="4.2")
boolean isEmpty()

Shortcut for getDataset() == null.

Since:

4.2

getLanguage

@ApiDoc(comment="The language for which this value is stored.",
        since="4.2")
Language getLanguage()

The language for which this value is stored.

Since:

4.2

getDataset

@ApiDoc(comment="The stored dataset - may be null",
        since="4.2")
@Nullable
@Nullable Dataset getDataset()

The stored dataset - may be null

Since:

4.2

getTemplateUid

@ApiDoc(comment="The uid of the template.",
        since="4.2")
String getTemplateUid()

The uid of the template.

Since:

4.2

getKey

@ApiDoc(comment="The key value of the entity.",
        since="4.2")
@Nullable
@Nullable KeyValue getKey()

The key value of the entity.

Since:

4.2

getGid

@ApiDoc(comment="The gid of the entity",
        since="5.0.307")
@Nullable
@Nullable UUID getGid()

The gid of the entity

Since:

5.0.307