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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommitContext.ValidationMode Validation mode.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	authorizationRequired
protected java.util.Collection<Entity>	commitInstances
protected java.util.Map<java.lang.String,java.lang.Object>	dbHints
protected boolean	discardCommitted
protected boolean	joinTransaction
protected java.util.Collection<Entity>	removeInstances
protected boolean	softDeletion
protected java.util.List<java.lang.Class>	validationGroups
protected CommitContext.ValidationMode	validationMode
protected java.util.Map<java.lang.Object,View>	views

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.List<java.lang.Class>	getValidationGroups()
CommitContext.ValidationMode	getValidationMode()
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)
void	setValidationGroups(java.util.List<java.lang.Class> validationGroups) Sets groups targeted for validation.
void	setValidationMode(CommitContext.ValidationMode validationMode) Sets CommitContext.ValidationMode for commit context.

Methods inherited from class java.lang.Object

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

Field Detail

commitInstances

protected java.util.Collection<Entity> commitInstances

removeInstances

protected java.util.Collection<Entity> removeInstances

views

protected java.util.Map<java.lang.Object,View> views

softDeletion

protected boolean softDeletion

discardCommitted

protected boolean discardCommitted

authorizationRequired

protected boolean authorizationRequired

joinTransaction

protected boolean joinTransaction

validationMode

protected CommitContext.ValidationMode validationMode

dbHints

protected java.util.Map<java.lang.String,java.lang.Object> dbHints

validationGroups

protected java.util.List<java.lang.Class> validationGroups

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.

getValidationMode

public CommitContext.ValidationMode getValidationMode()

Returns:

CommitContext.ValidationMode of commit context.

setValidationMode

public void setValidationMode(CommitContext.ValidationMode validationMode)

Sets CommitContext.ValidationMode for commit context. Validation type is responsible for whether entity bean validation will be applied on DataManager level.

Parameters:

validationMode - validation type

See Also:

BeanValidation

isAuthorizationRequired

public boolean isAuthorizationRequired()

setAuthorizationRequired

public CommitContext setAuthorizationRequired(boolean authorizationRequired)

isJoinTransaction

public boolean isJoinTransaction()

setJoinTransaction

public CommitContext setJoinTransaction(boolean joinTransaction)

getValidationGroups

public java.util.List<java.lang.Class> getValidationGroups()

Returns:

groups targeted for validation.

See Also:

Validator.validate(Object, Class[])

setValidationGroups

public void setValidationGroups(java.util.List<java.lang.Class> validationGroups)

Sets groups targeted for validation.

Parameters:

validationGroups - Set of groups

See Also:

Validator.validate(Object, Class[])