com.haulmont.cuba.core.global

Class CommitContext

java.lang.Object

com.haulmont.cuba.core.global.CommitContext

All Implemented Interfaces:

java.io.Serializable

public class CommitContext
extends java.lang.Object
implements java.io.Serializable

DTO that contains information about currently committed entities.
Used by DataService

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommitContext(java.util.Collection commitInstances)
CommitContext(java.util.Collection commitInstances, java.util.Collection removeInstances)
CommitContext(Entity... commitInstances)

Method Summary

Modifier and Type	Method and Description
CommitContext	addInstanceToCommit(Entity entity) Adds an entity to be committed to the database.
CommitContext	addInstanceToCommit(Entity entity, java.lang.String viewName) Adds an entity to be committed to the database.
CommitContext	addInstanceToCommit(Entity entity, View view) Adds an entity to be committed to the database.
CommitContext	addInstanceToRemove(Entity entity) Adds an entity to be removed from the database.
java.util.Collection<Entity>	getCommitInstances()
java.util.Map<java.lang.String,java.lang.Object>	getDbHints()
java.util.Collection<Entity>	getRemoveInstances()
java.util.Map<java.lang.Object,View>	getViews() Enables defining a view for each committed entity.
boolean	isAuthorizationRequired()
boolean	isDiscardCommitted()
boolean	isJoinTransaction()
boolean	isSoftDeletion()
CommitContext	setAuthorizationRequired(boolean authorizationRequired)
void	setCommitInstances(java.util.Collection commitInstances)
void	setDiscardCommitted(boolean discardCommitted) Set to true if calling code does not need committed instances, which allows for performance optimization.
CommitContext	setJoinTransaction(boolean joinTransaction)
void	setRemoveInstances(java.util.Collection removeInstances)
void	setSoftDeletion(boolean softDeletion)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommitContext

public CommitContext(Entity... commitInstances)

Parameters:

commitInstances - changed entities to be committed to the database

CommitContext

public CommitContext(java.util.Collection commitInstances)

Parameters:

commitInstances - collection of changed entities to be committed to the database

CommitContext

public CommitContext(java.util.Collection commitInstances,
                     java.util.Collection removeInstances)

Parameters:

commitInstances - collection of changed entities to be committed to the database

removeInstances - collection of entities to be removed from the database

Method Detail

addInstanceToCommit

public CommitContext addInstanceToCommit(Entity entity)

Adds an entity to be committed to the database.

Parameters:

entity - entity instance

Returns:

this instance for chaining

addInstanceToCommit

public CommitContext addInstanceToCommit(Entity entity,
                                         @Nullable
                                         View view)

Adds an entity to be committed to the database.

Parameters:

entity - entity instance

view - view which is used in merge operation to ensure all required attributes are loaded in the returned instance

Returns:

this instance for chaining

addInstanceToCommit

public CommitContext addInstanceToCommit(Entity entity,
                                         @Nullable
                                         java.lang.String viewName)

Adds an entity to be committed to the database.

Parameters:

entity - entity instance

viewName - view which is used in merge operation to ensure all required attributes are loaded in the returned instance

Returns:

this instance for chaining

addInstanceToRemove

public CommitContext addInstanceToRemove(Entity entity)

Adds an entity to be removed from the database.

Parameters:

entity - entity instance

Returns:

this instance for chaining

getCommitInstances

public java.util.Collection<Entity> getCommitInstances()

Returns:

direct reference to collection of changed entities that will be committed to the database. The collection is modifiable.

setCommitInstances

public void setCommitInstances(java.util.Collection commitInstances)

Parameters:

commitInstances - collection of changed entities that will be committed to the database

getRemoveInstances

public java.util.Collection<Entity> getRemoveInstances()

Returns:

direct reference to collection of entities that will be removed from the database. The collection is modifiable.

setRemoveInstances

public void setRemoveInstances(java.util.Collection removeInstances)

Parameters:

removeInstances - collection of entities to be removed from the database

getViews

public java.util.Map<java.lang.Object,View> getViews()

Enables defining a view for each committed entity. These views are used in merge operation to ensure all required attributes are loaded in returned instances.

Returns:

editable map of entities to their views

getDbHints

public java.util.Map<java.lang.String,java.lang.Object> getDbHints()

Returns:

custom hints which can be used later during query construction

isSoftDeletion

public boolean isSoftDeletion()

Returns:

whether to use soft deletion for this commit

setSoftDeletion

public void setSoftDeletion(boolean softDeletion)

Parameters:

softDeletion - whether to use soft deletion for this commit

isDiscardCommitted

public boolean isDiscardCommitted()

Returns:

true if calling code does not need committed instances, which allows for performance optimization

setDiscardCommitted

public void setDiscardCommitted(boolean discardCommitted)

Set to true if calling code does not need committed instances, which allows for performance optimization.

isAuthorizationRequired

public boolean isAuthorizationRequired()

setAuthorizationRequired

public CommitContext setAuthorizationRequired(boolean authorizationRequired)

isJoinTransaction

public boolean isJoinTransaction()

setJoinTransaction

public CommitContext setJoinTransaction(boolean joinTransaction)