server/io.spine.server.entity/TransactionalEntity

TransactionalEntity

public abstract class TransactionalEntity<I, S extends EntityState, B extends 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 validating builder for the state as the only way to modify the state from the descendants.

Inheritors

CommandHandlingEntity

Projection

Constructors

TransactionalEntity

protected void TransactionalEntity()

Creates a new instance.

protected void TransactionalEntity(I id)

Creates a new instance.

Functions

builder

protected B builder()

Obtains the instance of the state builder.

changed

public final boolean changed()

Determines whether the state of this entity or its lifecycle flags have been modified since this entity instance creation.

clearRecentHistory

protected void clearRecentHistory()

Clears recent history.

getLifecycleFlags

public final LifecycleFlags getLifecycleFlags()

Obtains the current state of the entity lifecycle flags.

missingTxMessage

protected String missingTxMessage()

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

recentHistory

protected RecentHistory recentHistory()

Obtains recent history of events of this entity.

remember

protected void remember(Iterable<Event> events)

Adds events to the recent history.

setArchived

protected final void setArchived(boolean archived)

Sets archived} status flag to the passed value.

setDeleted

protected final void setDeleted(boolean deleted)

Sets deleted} status flag to the passed value.

setInitialState

protected final void setInitialState(S initialState, 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.

Inherited functions

afterInvoke

public void afterInvoke(HandlerMethod<? extends Object, ? extends Object, ? extends Object, ? extends Object> method)

A callback for a handler method invocation end.

public final Api at(Level logLevel)

Obtains a new fluent logging API at the given level.

beforeInvoke

public void beforeInvoke(HandlerMethod<? extends Object, ? extends Object, ? extends Object, ? extends Object> method)

A callback for a handler method invocation start.

checkEntityState

protected final List<ConstraintViolation> checkEntityState(S newState)

Verifies the new entity state and returns ConstraintViolations, if any.

checkNotArchived

protected void checkNotArchived()

Ensures that the entity is not marked as archived.

checkNotDeleted

protected void checkNotDeleted()

Ensures that the entity is not marked as deleted.

defaultState

protected final S defaultState()

Obtains the default state of the entity.

ensureAccessToState

protected void ensureAccessToState()

Ensures that the callee is allowed to access Entity's state() method.

equals

public boolean equals(Object o)

hashCode

public int hashCode()

public I id()

Obtains the identifier of the entity.

idAsString

public String idAsString()

Obtains ID of the entity in the string form.

isActive

public boolean isActive()

Verifies if any of the lifecycle attributes is set.

isArchived

public final boolean isArchived()

Tests whether the entity is marked as archived.

isDeleted

public final boolean isDeleted()

Tests whether the entity is marked as deleted.

lifecycleFlags

public LifecycleFlags lifecycleFlags()

Obtains current lifecycle flags.

lifecycleFlagsChanged

public boolean lifecycleFlagsChanged()

Tells whether lifecycle flags of the entity changed since its initialization.

modelClass

protected EntityClass<? extends Object> modelClass()

Obtains the model class.

state

public final S state()

Obtains the state of the entity.

thisClass

protected EntityClass<? extends Object> thisClass()

Obtains model class for this entity.

toString

public String toString()

version

public Version version()

Obtains the version of the entity.

versionNumber

protected int versionNumber()

Obtains the version number of the entity.

whenModified

public Timestamp whenModified()

Obtains timestamp of the entity version.