Interface AggregateRoot<T>

Type Parameters:

T - the type of the underlying domain object

All Superinterfaces:

Entity<T>, PersistedRoot<T>

All Known Implementing Classes:

ImmutableAggregateRoot, LazyAggregateRoot, ModifiableAggregateRoot

public interface AggregateRoot<T>
extends PersistedRoot<T>

Represents the root of a legacy aggregate in a domain model.

This compatibility specialization retains aggregate vocabulary while the shared persisted-root contract lives in PersistedRoot. Existing aggregate implementations and callers remain valid.

See Also:

• Entity
• Aggregate
• PersistedRoot

Field Summary

Fields inherited from interface Entity

AGGREGATE_ID_METADATA_KEY, AGGREGATE_SN_METADATA_KEY, AGGREGATE_TYPE_METADATA_KEY, ALREADY_EXISTS_EXCEPTION, applying, loading, NOT_FOUND_EXCEPTION

Method Summary

Modifier and Type	Method	Description
String	lastEventId()	Retrieves the identifier of the last event applied to the entity hierarchy.
Long	lastEventIndex()	Retrieves the index of the last event applied to this entity hierarchy.
default Entity<?>	parent()	Retrieves the parent entity of the current entity.
Entity<T>	previous()	Retrieves the previous version of this entity.
long	sequenceNumber()	Retrieves the sequence number of the current entity.
Instant	timestamp()	Retrieves the timestamp of the entity.
Entity<T>	withEventIndex(Long index, String messageId)	Updates the event index and message ID of the entity and returns the updated version of the entity.
Entity<T>	withSequenceNumber(long sequenceNumber)	Returns an updated entity based on this with the specified sequence number.

Methods inherited from interface Entity

aliases, allEntities, ancestors, ancestorValue, apply, apply, apply, apply, apply, apply, assertAndApply, assertAndApply, assertAndApply, assertAndApply, assertLegal, associations, commit, depth, dissociations, entities, filterEntity, filterPresent, findEntity, get, getEntity, getEntity, highestEventIndex, id, idProperty, ifPresent, isEmpty, isPresent, isRoot, map, mapEntity, mapIfPresent, orElse, orElseGet, orElseThrow, orElseThrow, playBackToCondition, playBackToEvent, possibleTargets, relationships, root, rootAnnotation, rootConfiguration, type, update, withType

Method Details

parent

default Entity<?> parent()

Description copied from interface: Entity

Retrieves the parent entity of the current entity.

Specified by:

parent in interface Entity<T>

Specified by:

parent in interface PersistedRoot<T>

Returns:

the parent entity of the current entity, or null if this entity does not have a parent

lastEventId

String lastEventId()

Description copied from interface: Entity

Retrieves the identifier of the last event applied to the entity hierarchy.

Specified by:

lastEventId in interface Entity<T>

Specified by:

lastEventId in interface PersistedRoot<T>

Returns:

the identifier of the last event as a string, or null if no events have been recorded in the entity's aggregate

lastEventIndex

Long lastEventIndex()

Description copied from interface: Entity

Retrieves the index of the last event applied to this entity hierarchy.

Specified by:

lastEventIndex in interface Entity<T>

Specified by:

lastEventIndex in interface PersistedRoot<T>

Returns:

the index of the last event as a Long, or null if no events have been recorded for the entity's aggregate

withEventIndex

Entity<T> withEventIndex(Long index,
 String messageId)

Description copied from interface: Entity

Updates the event index and message ID of the entity and returns the updated version of the entity.

Specified by:

withEventIndex in interface Entity<T>

Specified by:

withEventIndex in interface PersistedRoot<T>

Parameters:

index - the event index to set for the root entity

messageId - the message ID associated with the event

Returns:

the updated entity corresponding to the current entity's ID and type, or null if no such entity can be found

sequenceNumber

long sequenceNumber()

Description copied from interface: Entity

Retrieves the sequence number of the current entity.

Specified by:

sequenceNumber in interface Entity<T>

Specified by:

sequenceNumber in interface PersistedRoot<T>

Returns:

the sequence number of the root entity

withSequenceNumber

Entity<T> withSequenceNumber(long sequenceNumber)

Description copied from interface: Entity

Returns an updated entity based on this with the specified sequence number.

Specified by:

withSequenceNumber in interface Entity<T>

Specified by:

withSequenceNumber in interface PersistedRoot<T>

Parameters:

sequenceNumber - the sequence number to assign to the entity

Returns:

the updated entity with the specified sequence number, or null if the entity could not be found in the entity hierarchy

timestamp

Instant timestamp()

Description copied from interface: Entity

Retrieves the timestamp of the entity.

Specified by:

timestamp in interface Entity<T>

Specified by:

timestamp in interface PersistedRoot<T>

Returns:

the timestamp as an Instant obtained from the root entity

previous

Entity<T> previous()

Description copied from interface: Entity

Retrieves the previous version of this entity.

Specified by:

previous in interface Entity<T>

Specified by:

previous in interface PersistedRoot<T>

Returns:

the previous state of the entity, or null if this is the first known version