io.spine.server.entity

Interface Entity<I,S extends io.spine.base.EntityState>

Type Parameters:

I - the type of the entity identifier

S - the type of the entity state

All Superinterfaces:

WithLifecycle

All Known Implementing Classes:

AbstractEntity, Aggregate, AggregatePart, CommandHandlingEntity, ProcessManager, Projection, TenantRepository.Entity, TransactionalEntity

public interface Entity<I,S extends io.spine.base.EntityState>
extends WithLifecycle

A server-side object with an identity.

A state of an entity is defined as a Protobuf message.

Lifecycle flags determine if an entity is active. An entity is considered to be active if the lifecycle flags are not set. If an entity is archived or deleted, then it’s regarded to be inactive.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Entity.GenericParameter Enumeration of generic type parameters of this interface.

Method Summary

Modifier and Type	Method and Description
I	id() Obtains the identifier of the entity.
default java.lang.String	idAsString() Obtains string representation of the entity identifier.
boolean	lifecycleFlagsChanged() Tells whether lifecycle flags of the entity changed since its initialization.
S	state() Obtains the state of the entity.
io.spine.core.Version	version() Obtains the version of the entity.

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

getLifecycleFlags, isActive, isArchived, isDeleted, lifecycleFlags

Method Detail

id

I id()

Obtains the identifier of the entity.

idAsString

default java.lang.String idAsString()

Obtains string representation of the entity identifier.

API Note:

The primary purpose of this method is to display the identifier in human-readable form in debug and error messages.

state

S state()

Obtains the state of the entity.

lifecycleFlagsChanged

boolean lifecycleFlagsChanged()

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

version

io.spine.core.Version version()

Obtains the version of the entity.