wow-api/me.ahoo.wow.api.query/MaterializedSnapshot

MaterializedSnapshot

data class MaterializedSnapshot<S : Any>(val contextName: String, val aggregateName: String, val tenantId: String, val ownerId: String = OwnerId.DEFAULT_OWNER_ID, val aggregateId: String, val version: Int, val eventId: String, val firstOperator: String, val operator: String, val firstEventTime: Long, val eventTime: Long, val state: S, val snapshotTime: Long, val deleted: Boolean) : IMaterializedSnapshot<MaterializedSnapshot<S>, S> , NamedAggregate, TenantId, OwnerId, Version, EventIdCapable, FirstOperatorCapable, OperatorCapable, FirstEventTimeCapable, EventTimeCapable, SnapshotTimeCapable, DeletedCapable

Data class representing a complete materialized snapshot of an aggregate's state.

This class contains all the information about an aggregate's state at a specific point in time, including metadata about the aggregate, versioning information, event tracking, and the actual state data. It implements multiple interfaces to provide comprehensive access to all snapshot properties.

Parameters

The type of the state data.

Constructors

MaterializedSnapshot

constructor(contextName: String, aggregateName: String, tenantId: String, ownerId: String = OwnerId.DEFAULT_OWNER_ID, aggregateId: String, version: Int, eventId: String, firstOperator: String, operator: String, firstEventTime: Long, eventTime: Long, state: S, snapshotTime: Long, deleted: Boolean)

Properties

aggregateId

val aggregateId: String

The unique identifier of this aggregate instance.

aggregateName

open override val aggregateName: String

The name of the aggregate.

contextName

open override val contextName: String

The name of the context this aggregate belongs to.

deleted

open override val deleted: Boolean

Whether this aggregate has been marked as deleted.

eventId

open override val eventId: String

The identifier of the last event that led to this snapshot.

eventTime

open override val eventTime: Long

The timestamp of the last event for this aggregate.

firstEventTime

open override val firstEventTime: Long

The timestamp of the first event for this aggregate.

firstOperator

open override val firstOperator: String

The identifier of the first operator who performed an operation on this aggregate.

initialized

open val initialized: Boolean

A computed property that indicates whether the entity has been initialized. Returns true if the version is greater than UNINITIALIZED_VERSION. This property is ignored during JSON serialization.

isInitialVersion

open val isInitialVersion: Boolean

A computed property that indicates whether the entity is at its initial version. Returns true if the version equals INITIAL_VERSION. This property is ignored during JSON serialization.

operator

open override val operator: String

The identifier of the last operator who performed an operation on this aggregate.

ownerId

open override val ownerId: String

The identifier of the owner of this aggregate. Defaults to the default owner ID.

snapshotTime

open override val snapshotTime: Long

The timestamp when this snapshot was created.

state

open override val state: S

The actual state data of the aggregate.

tenantId

open override val tenantId: String

The identifier of the tenant that owns this aggregate.

version

open override val version: Int

The version number of this snapshot.

Functions

isSameAggregateName

open fun isSameAggregateName(other: NamedAggregate): Boolean

Checks if two aggregates belong to the same context and have the same aggregate name.

isSameBoundedContext

open fun isSameBoundedContext(other: NamedBoundedContext): Boolean

Checks if this entity belongs to the same bounded context as another entity.

toMedium

fun <S : Any, D : Any> MaterializedSnapshot<S>.toMedium(materialize: (S) -> D): MediumMaterializedSnapshot<D>

toSmall

fun <S : Any, D : Any> MaterializedSnapshot<S>.toSmall(materialize: (S) -> D): SmallMaterializedSnapshot<D>

Converts a materialized snapshot into a simplified snapshot form. This function is used to transform a full snapshot into a simplified snapshot with transformed state.

withState

open override fun withState(state: S): MaterializedSnapshot<S>

Creates a new MaterializedSnapshot with the specified state.