com.haulmont.cuba.gui.data

Interface DsContext

All Known Subinterfaces:

DsContextImplementation

All Known Implementing Classes:

DsContextImpl

public interface DsContext

Interface providing access to datasources defined in a screen.
Implementation of this interface serves also for automatic coordination between datasources on load/commit time.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DsContext.AfterCommitListener
static interface	DsContext.BeforeCommitListener This listener allows to intercept commit events.
static interface	DsContext.CommitListener Deprecated. Use DsContext.BeforeCommitListener and DsContext.AfterCommitListener
static class	DsContext.CommitListenerAdapter Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addAfterCommitListener(DsContext.AfterCommitListener listener)
void	addAlias(java.lang.String aliasDatasourceId, java.lang.String originalDatasourceId) Add alias for datasource.
void	addBeforeCommitListener(DsContext.BeforeCommitListener listener)
void	addListener(DsContext.CommitListener listener) Deprecated.
boolean	commit() Commit all changed datasources.
Datasource	get(java.lang.String name) Get datasource by name.
java.util.Collection<Datasource>	getAll()
java.util.List<DsContext>	getChildren()
DataSupplier	getDataSupplier()
FrameContext	getFrameContext()
Datasource	getNN(java.lang.String name) Get datasource by name.
DsContext	getParent()
boolean	isDiscardCommitted() Indicates that the DsContext will be discarded right after commit hence it doesn't need committed instances.
boolean	isModified()
void	refresh() Refresh all datasources.
void	registerDependency(Datasource ds, Datasource dependFrom, java.lang.String property) Register dependency between datasources.
void	removeAfterCommitListener(DsContext.AfterCommitListener listener)
void	removeBeforeCommitListener(DsContext.BeforeCommitListener listener)
void	removeListener(DsContext.CommitListener listener) Deprecated.
void	setDiscardCommitted(boolean discardCommitted) Set to true if the DsContext will be discarded right after commit hence it doesn't need committed instances.
void	setFrameContext(FrameContext context)

Method Detail

getFrameContext

FrameContext getFrameContext()

Returns:

context of a frame that owns this DsContext. If the DsContext belongs to Window, its WindowContext is returned.

setFrameContext

void setFrameContext(FrameContext context)

getDataSupplier

DataSupplier getDataSupplier()

Returns:

a reference to DataSupplier

get

@Nullable
Datasource get(java.lang.String name)

Get datasource by name. Name may contain path to a datasource in nested frame e.g. someFrameId.someDatasourceId

Parameters:

name - datasource name

Returns:

datasource instance or null if not found

getNN

Datasource getNN(java.lang.String name)

Get datasource by name. Name may contain path to a datasource in nested frame e.g. someFrameId.someDatasourceId.

Never returns null.

Parameters:

name - datasource name

Returns:

datasource instance

Throws:

java.lang.IllegalArgumentException - if not found

getAll

java.util.Collection<Datasource> getAll()

Returns:

all datasources contained in this context

addAlias

void addAlias(java.lang.String aliasDatasourceId,
              java.lang.String originalDatasourceId)

Add alias for datasource.

Parameters:

aliasDatasourceId - additional datasource id

originalDatasourceId - original datasource id

isModified

boolean isModified()

Returns:

true if any contained datasource is modified

refresh

void refresh()

Refresh all datasources.

commit

boolean commit()

Commit all changed datasources.

Returns:

true if there were changes and commit has been done

isDiscardCommitted

boolean isDiscardCommitted()

Indicates that the DsContext will be discarded right after commit hence it doesn't need committed instances.

setDiscardCommitted

void setDiscardCommitted(boolean discardCommitted)

Set to true if the DsContext will be discarded right after commit hence it doesn't need committed instances.

registerDependency

void registerDependency(Datasource ds,
                        Datasource dependFrom,
                        @Nullable
                        java.lang.String property)

Register dependency between datasources.
Dependent datasource is refreshed if one of the following events occurs on master datasource:

• itemChanged
• collectionChanged with Operation.REFRESH
• valueChanged with the specified property

Parameters:

ds - dependent datasource

dependFrom - master datasource

property - property of master datasource. If specified, the dependent datasource will be refreshed also on this property value change

addListener

@Deprecated
void addListener(DsContext.CommitListener listener)

Deprecated.

Add commit events listener.

removeListener

@Deprecated
void removeListener(DsContext.CommitListener listener)

Deprecated.

Remove commit events listener.

addBeforeCommitListener

void addBeforeCommitListener(DsContext.BeforeCommitListener listener)

removeBeforeCommitListener

void removeBeforeCommitListener(DsContext.BeforeCommitListener listener)

addAfterCommitListener

void addAfterCommitListener(DsContext.AfterCommitListener listener)

removeAfterCommitListener

void removeAfterCommitListener(DsContext.AfterCommitListener listener)

getParent

@Nullable
DsContext getParent()

Returns:

a parent DsContext if this DsContext is defined in a frame

getChildren

java.util.List<DsContext> getChildren()

Returns:

list of DsContext's of frames included in the current screen, if any