org.axonframework.commandhandling.model.inspection

Interface EntityModel<T>

Type Parameters:

T - The type of entity described by this model

All Known Subinterfaces:

AggregateModel<T>

All Known Implementing Classes:

ModelInspector

public interface EntityModel<T>

Interface of an entity model that describes the properties and capabilities of an entity of type T. The entity may be child entity or an aggregate root.

Method Summary

Modifier and Type	Method and Description
default MessageHandlingMember<? super T>	commandHandler(String commandName) Get the MessageHandlingMember capable of handling commands with given commandName (see CommandMessage.getCommandName()).
Map<String,MessageHandlingMember<? super T>>	commandHandlers() Get a mapping of MessageHandlingMember to command name (obtained via CommandMessage.getCommandName()).
Class<? extends T>	entityClass() Returns the class this model describes
Object	getIdentifier(T target) Get the identifier of the given target entity.
<C> EntityModel<C>	modelOf(Class<? extends C> childEntityType) Get the EntityModel of an entity of type childEntityType in case it is the child of the modeled entity.
void	publish(EventMessage<?> message, T target) Publish given event message on the given target entity.
String	routingKey() Get the name of the routing key property on commands and events that provides the identifier that should be used to target entities of this kind.

Method Detail

getIdentifier

Object getIdentifier(T target)

Get the identifier of the given target entity.

Parameters:

target - The entity instance

Returns:

The identifier of the given target entity

routingKey

String routingKey()

Get the name of the routing key property on commands and events that provides the identifier that should be used to target entities of this kind.

Returns:

The name of the routing key that holds the identifier used to target this sort of entity

publish

void publish(EventMessage<?> message,
             T target)

Publish given event message on the given target entity.

Parameters:

message - The event message to publish

target - The target entity for the event

commandHandlers

Map<String,MessageHandlingMember<? super T>> commandHandlers()

Get a mapping of MessageHandlingMember to command name (obtained via CommandMessage.getCommandName()).

Returns:

Map of message handler to command name

commandHandler

default MessageHandlingMember<? super T> commandHandler(String commandName)

Get the MessageHandlingMember capable of handling commands with given commandName (see CommandMessage.getCommandName()). If the entity is not capable of handling such commands an exception is raised.

Parameters:

commandName - The name of the command

Returns:

The handler for the command

Throws:

NoHandlerForCommandException - In case the entity is not capable of handling commands of given name

modelOf

<C> EntityModel<C> modelOf(Class<? extends C> childEntityType)

Get the EntityModel of an entity of type childEntityType in case it is the child of the modeled entity.

Type Parameters:

C - the type of the child entity

Parameters:

childEntityType - The class instance of the child entity type

Returns:

An EntityModel for the child entity

entityClass

Class<? extends T> entityClass()

Returns the class this model describes

Returns:

the class this model describes