com.haulmont.cuba.gui.data.impl

Interface DatasourceImplementation<T extends Entity>

All Superinterfaces:

Datasource<T>

All Known Implementing Classes:

AbstractCollectionDatasource, AbstractDatasource, AbstractTreeDatasource, AbstractTreeTableDatasource, AppPropertiesDatasource, BasicPermissionTreeDatasource, CollectionDatasourceImpl, CollectionPropertyDatasourceImpl, ConditionDescriptorsDs, ConditionsDs, CustomCollectionDatasource, CustomGroupDatasource, CustomHierarchicalDatasource, CustomValueCollectionDatasource, CustomValueGroupDatasource, CustomValueHierarchicalDatasource, DatasourceImpl, DiffTreeDatasource, EmbeddedDatasourceImpl, EntityDiffDatasource, EntityParamsDatasource, EntityPermissionTargetsDatasource, EntitySnapshotsDatasource, GroupDatasourceImpl, GroupPropertyDatasourceImpl, HierarchicalDatasourceImpl, HierarchicalPropertyDatasourceImpl, JmxInstancesDatasource, ManagedBeanAttributeDatasource, ManagedBeanInfoDatasource, MultiplePermissionTargetsDatasource, PropertyDatasourceImpl, RestorablePermissionDatasource, RuntimePropsDatasourceImpl, ScreenComponentsTreeDatasource, ScreenHistoryDatasource, ScreenPermissionTreeDatasource, SpecificPermissionTreeDatasource, StatisticsDatasource, ThreadsDatasource, UiPermissionsDatasource, UserSessionsDatasource, ValueCollectionDatasourceImpl, ValueGroupDatasourceImpl, ValueHierarchicalDatasourceImpl

public interface DatasourceImplementation<T extends Entity>
extends Datasource<T>

INTERNAL. Common internal methods of datasources.

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.data.Datasource

Datasource.CommitMode, Datasource.ItemChangeEvent<T extends Entity>, Datasource.ItemChangeListener<T extends Entity>, Datasource.ItemPropertyChangeEvent<T extends Entity>, Datasource.ItemPropertyChangeListener<T extends Entity>, Datasource.State, Datasource.StateChangeEvent<T extends Entity>, Datasource.StateChangeListener<T extends Entity>

Method Summary

Modifier and Type	Method and Description
void	clearCommitLists() Clear new, modified and deleted lists.
void	committed(java.util.Set<Entity> entities) Invoked after commit.
void	deleted(T item) Invoked when the given instance is deleted.
boolean	enableListeners(boolean enable) Enables or disables datasource listeners.
java.util.Collection<T>	getItemsToCreate() New instances to be committed.
java.util.Collection<T>	getItemsToDelete() Deleted instances to be committed.
java.util.Collection<T>	getItemsToUpdate() Modified instances to be committed.
Datasource	getParent() Returns parent datasource or null.
void	initialized() Moves the datasource to State#INVALID.
void	modified(T item) Invoked when the given instance is modified.
void	setCommitMode(Datasource.CommitMode commitMode) Sets commit mode explicitly.
void	setModified(boolean modified) Sets "modified" state.
void	setParent(Datasource datasource) Sets parent datasource.
void	valid() Moves the datasource to State#VALID.

Methods inherited from interface com.haulmont.cuba.gui.data.Datasource

addItemChangeListener, addItemPropertyChangeListener, addStateChangeListener, commit, getCommitMode, getDataSupplier, getDsContext, getId, getItem, getItemIfValid, getLoadDynamicAttributes, getMetaClass, getState, getView, invalidate, isAllowCommit, isModified, refresh, removeItemChangeListener, removeItemPropertyChangeListener, removeStateChangeListener, setAllowCommit, setItem, setLoadDynamicAttributes, setup

Method Detail

initialized

void initialized()

Moves the datasource to State#INVALID.

valid

void valid()

Moves the datasource to State#VALID.

setModified

void setModified(boolean modified)

Sets "modified" state.

setCommitMode

void setCommitMode(Datasource.CommitMode commitMode)

Sets commit mode explicitly. Usually commit mode is defined by the presence of a parent datasource.

See Also:

setParent(Datasource)

getParent

@Nullable
Datasource getParent()

Returns parent datasource or null.

If a parent datasource is set, it will receive changed data from the current datasource on commit. Otherwise, the datasource commits to the database.

setParent

void setParent(Datasource datasource)

Sets parent datasource.

If a parent datasource is set, it will receive changed data from the current datasource on commit. Otherwise, the datasource commits to the database.

getItemsToCreate

java.util.Collection<T> getItemsToCreate()

New instances to be committed.

getItemsToUpdate

java.util.Collection<T> getItemsToUpdate()

Modified instances to be committed.

getItemsToDelete

java.util.Collection<T> getItemsToDelete()

Deleted instances to be committed.

modified

void modified(T item)

Invoked when the given instance is modified.

deleted

void deleted(T item)

Invoked when the given instance is deleted.

committed

void committed(java.util.Set<Entity> entities)

Invoked after commit.

Parameters:

entities - committed entities returned from middleware

enableListeners

boolean enableListeners(boolean enable)

Enables or disables datasource listeners.

Parameters:

enable - true to enable, false to disable

Returns:

previous state

clearCommitLists

void clearCommitLists()

Clear new, modified and deleted lists.