io.spine.server.entity

Class TransactionalEntity<I,S extends com.google.protobuf.Message,B extends io.spine.protobuf.ValidatingBuilder<S>>

java.lang.Object

io.spine.server.entity.AbstractEntity<I,S>

io.spine.server.entity.TransactionalEntity<I,S,B>

All Implemented Interfaces:

Entity<I,S>, WithLifecycle

Direct Known Subclasses:

CommandHandlingEntity, Projection

public abstract class TransactionalEntity<I,S extends com.google.protobuf.Message,B extends io.spine.protobuf.ValidatingBuilder<S>>
extends AbstractEntity<I,S>

A base for entities, perform transactions events.

Defines a transaction-based mechanism for state, version, and lifecycle flags update.

Exposes TransactionalEntity.builder() validating builder} for the state as the only way to modify the state from the descendants.

Nested Class Summary

Nested classes/interfaces inherited from interface io.spine.server.entity.Entity

Entity.GenericParameter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransactionalEntity() Creates a new instance.
protected	TransactionalEntity(I id) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected B	builder() Obtains the instance of the state builder.
protected void	clearRecentHistory() Clears recent history.
io.spine.server.entity.LifecycleFlags	getLifecycleFlags() Obtains the current state of the entity lifecycle flags.
protected java.lang.String	missingTxMessage() Provides error message text for the case of not having an active transaction when a state modification call is made.
protected RecentHistory	recentHistory() Obtains recent history of events of this entity.
protected void	remember(java.lang.Iterable<io.spine.core.Event> events) Adds events to the recent history.
protected void	setArchived(boolean archived) Sets archived status flag to the passed value.
protected void	setDeleted(boolean deleted) Sets deleted status flag to the passed value.
protected void	setInitialState(S initialState, io.spine.core.Version version) Sets an initial state for the entity.
protected Transaction<I,? extends TransactionalEntity<I,S,B>,S,B>	tx() Obtains the transaction used for modifying the entity.

Methods inherited from class io.spine.server.entity.AbstractEntity

checkEntityState, checkNotArchived, checkNotDeleted, defaultState, equals, getVersion, hashCode, id, idAsString, isArchived, isDeleted, lifecycleFlagsChanged, state, toString, version, versionNumber, whenModified

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.spine.server.entity.WithLifecycle

isActive, lifecycleFlags

Constructor Detail

TransactionalEntity

protected TransactionalEntity()

Creates a new instance.

TransactionalEntity

protected TransactionalEntity(I id)

Creates a new instance.

Parameters:

id - the ID for the new instance

Method Detail

recentHistory

protected RecentHistory recentHistory()

Obtains recent history of events of this entity.

remember

protected void remember(java.lang.Iterable<io.spine.core.Event> events)

Adds events to the recent history.

clearRecentHistory

protected void clearRecentHistory()

Clears recent history.

builder

protected B builder()

Obtains the instance of the state builder.

This method must be called only from within an active transaction.

Returns:

the instance of the new state builder

Throws:

java.lang.IllegalStateException - if the method is called not within a transaction

missingTxMessage

protected java.lang.String missingTxMessage()

Provides error message text for the case of not having an active transaction when a state modification call is made.

tx

protected Transaction<I,? extends TransactionalEntity<I,S,B>,S,B> tx()

Obtains the transaction used for modifying the entity.

Throws:

java.lang.IllegalStateException - if the entity is not in the modification phase

setInitialState

protected final void setInitialState(S initialState,
                                     io.spine.core.Version version)

Sets an initial state for the entity.

The execution of this method requires a presence of active transaction.

getLifecycleFlags

public final io.spine.server.entity.LifecycleFlags getLifecycleFlags()

Obtains the current state of the entity lifecycle flags.

If the transaction is in progress, returns the lifecycle flags value for the transaction.

Specified by:

getLifecycleFlags in interface WithLifecycle

Overrides:

getLifecycleFlags in class AbstractEntity<I,S extends com.google.protobuf.Message>

See Also:

WithLifecycle.lifecycleFlags()

setArchived

protected final void setArchived(boolean archived)

Sets archived status flag to the passed value.

The execution of this method requires an active transaction.

Overrides:

setArchived in class AbstractEntity<I,S extends com.google.protobuf.Message>

setDeleted

protected final void setDeleted(boolean deleted)

Sets deleted status flag to the passed value.

The execution of this method requires an active transaction.

Overrides:

setDeleted in class AbstractEntity<I,S extends com.google.protobuf.Message>