org.axonframework.queryhandling

Interface QueryMessage<T,R>

All Superinterfaces:

Message<T>, Serializable

All Known Implementing Classes:

GenericQueryMessage

public interface QueryMessage<T,R>
extends Message<T>

Message type that carries a Query: a request for information. Besides a payload, Query Messages also carry the expected response type. This is the type of result expected by the caller.

Handlers should only answer a query if they can respond with the appropriate response type.

Since:

3.1

Author:

Marc Gathier

Method Summary

Modifier and Type	Method and Description
QueryMessage<T,R>	andMetaData(Map<String,?> additionalMetaData) Returns a copy of this Message with it MetaData merged with the given metaData.
String	getQueryName() Returns the name identifying the query to be executed.
Class<R>	getResponseType() The type of response expected by the sender of the query
QueryMessage<T,R>	withMetaData(Map<String,?> metaData) Returns a copy of this Message with the given metaData.

Methods inherited from interface org.axonframework.messaging.Message

getIdentifier, getMetaData, getPayload, getPayloadType

Method Detail

getQueryName

String getQueryName()

Returns the name identifying the query to be executed.

Returns:

the name identifying the query to be executed.

getResponseType

Class<R> getResponseType()

The type of response expected by the sender of the query

Returns:

the type of response expected by the sender of the query

withMetaData

QueryMessage<T,R> withMetaData(Map<String,?> metaData)

Description copied from interface: Message

Returns a copy of this Message with the given metaData. The payload remains unchanged.

While the implementation returned may be different than the implementation of this, implementations must take special care in returning the same type of Message (e.g. EventMessage, DomainEventMessage) to prevent errors further downstream.

Specified by:

withMetaData in interface Message<T>

Parameters:

metaData - The new MetaData for the Message

Returns:

a copy of this message with the given MetaData

andMetaData

QueryMessage<T,R> andMetaData(Map<String,?> additionalMetaData)

Description copied from interface: Message

Returns a copy of this Message with it MetaData merged with the given metaData. The payload remains unchanged.

Specified by:

andMetaData in interface Message<T>

Parameters:

additionalMetaData - The MetaData to merge with

Returns:

a copy of this message with the given MetaData