org.fuin.ddd4j.ddd

Interface AggregateRoot<ID extends AggregateRootId>

Type Parameters:

ID - Type of the aggregate root identifier.

All Superinterfaces:

Entity<ID>

All Known Implementing Classes:

AbstractAggregateRoot

public interface AggregateRoot<ID extends AggregateRootId>
extends Entity<ID>

Dedicated entity of a group of entities (The group is called "Aggregate") that guarantees the consistency of changes being made within the group by forbidding external objects from holding direct references to its members.

Method Summary

Modifier and Type	Method and Description
ID	getId() Returns the unique aggregate root identifier.
int	getNextVersion() Returns the next version of the aggregate.
@NotNull java.util.List<DomainEvent<?>>	getUncommittedChanges() Returns a list of uncommitted changes.
int	getVersion() Returns the current version of the aggregate.
boolean	hasUncommitedChanges() Returns the information if the aggregate has uncommited changes.
void	loadFromHistory(DomainEvent<?>... history) Loads the aggregate with historic events.
void	loadFromHistory(@NotNull java.util.List<DomainEvent<?>> history) Loads the aggregate with historic events.
void	markChangesAsCommitted() Clears the internal change list and sets the new version number.

Methods inherited from interface org.fuin.ddd4j.ddd.Entity

getType

Method Detail

getId

ID getId()

Returns the unique aggregate root identifier.

Specified by:

getId in interface Entity<ID extends AggregateRootId>

Returns:

Identifier.

getUncommittedChanges

@NotNull
@NotNull java.util.List<DomainEvent<?>> getUncommittedChanges()

Returns a list of uncommitted changes.

Returns:

List of events that were not persisted yet.

hasUncommitedChanges

boolean hasUncommitedChanges()

Returns the information if the aggregate has uncommited changes.

Returns:

TRUE if the aggregate will return a non-empty list for getUncommittedChanges(), else FALSE.

markChangesAsCommitted

void markChangesAsCommitted()

Clears the internal change list and sets the new version number.

getVersion

int getVersion()

Returns the current version of the aggregate.

Returns:

Current version that does NOT included uncommited changes.

getNextVersion

int getNextVersion()

Returns the next version of the aggregate.

Returns:

Next version that includes all currently uncommited changes.

loadFromHistory

void loadFromHistory(@NotNull
                     DomainEvent<?>... history)

Loads the aggregate with historic events.

Parameters:

history - List of historic events.

loadFromHistory

void loadFromHistory(@NotNull
                     @NotNull java.util.List<DomainEvent<?>> history)

Loads the aggregate with historic events.

Parameters:

history - List of historic events.