io.jmix.ui.model

Class DataContext.PreCommitEvent

java.lang.Object

java.util.EventObject

io.jmix.ui.model.DataContext.PreCommitEvent

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

DataContext

public static class DataContext.PreCommitEvent
extends java.util.EventObject

Event sent before committing changes.

In this event listener, you can add arbitrary entity instances to the committed collections returned by getModifiedInstances() and getRemovedInstances() methods, for example:

     @Subscribe(target = Target.DATA_CONTEXT)
     protected void onPreCommit(DataContext.PreCommitEvent event) {
         event.getModifiedInstances().add(customer);
     }
 

You can also prevent commit using the preventCommit() method of the event, for example:

     @Subscribe(target = Target.DATA_CONTEXT)
     protected void onPreCommit(DataContext.PreCommitEvent event) {
         if (doNotCommit()) {
             event.preventCommit();
         }
     }
 

See Also:

DataContext.addPreCommitListener(Consumer), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PreCommitEvent(DataContext dataContext, java.util.Collection modified, java.util.Collection removed)

Method Summary

Modifier and Type	Method and Description
java.util.Collection	getModifiedInstances() Returns the collection of modified instances.
java.util.Collection	getRemovedInstances() Returns the collection of removed instances.
DataContext	getSource() The data context which sent the event.
boolean	isCommitPrevented() Returns true if preventCommit() method was called and commit will be aborted.
void	preventCommit() Invoke this method if you want to abort the commit.

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PreCommitEvent

public PreCommitEvent(DataContext dataContext,
                      java.util.Collection modified,
                      java.util.Collection removed)

Method Detail

getSource

public DataContext getSource()

The data context which sent the event.

Overrides:

getSource in class java.util.EventObject

getModifiedInstances

public java.util.Collection getModifiedInstances()

Returns the collection of modified instances.

getRemovedInstances

public java.util.Collection getRemovedInstances()

Returns the collection of removed instances.

preventCommit

public void preventCommit()

Invoke this method if you want to abort the commit.

isCommitPrevented

public boolean isCommitPrevented()

Returns true if preventCommit() method was called and commit will be aborted.