Package com.aquima.interactions.communication

Interface ICommunicationEngineHandler

All Superinterfaces:

ISystemMessagesHandler

All Known Implementing Classes:

CommunicationEngineHandler

public interface ICommunicationEngineHandler
extends ISystemMessagesHandler

This interface should be implemented by the client using the communication engine to influence the behavior of the communication engine. This interface contains methods to compose custom schema elements.

Since:

9.0

Author:

Jon van Leuven

Method Summary

Modifier and Type	Method	Description
DataValue	composeElement(IElementReference customSchemaElement, InferenceContext profile)	This method is called by the communication engine when a custom schema element is encountered and should be composed.
void	composeElement(String customSchemaElement, InferenceContext profile, ICustomElementComposerContext context)	This method is called by the communication engine when a custom schema element is encountered and should be composed.
String	getDefaultSerializerMimeType()	Returns the mime type used by the default serializer.
IDataSerializer	getSerializer(String mimeType)	Returns a serializer for the specified mime type.

Methods inherited from interface com.aquima.interactions.foundation.text.ISystemMessagesHandler

containsMessage, getMessage, getMessage

Method Details

getSerializer

IDataSerializer getSerializer(String mimeType)

Returns a serializer for the specified mime type.

Parameters:

mimeType - The mime type to use, or null for the default serializer.

Returns:

The data serializer, returns null if no serializer is available for the mimeType.

getDefaultSerializerMimeType

String getDefaultSerializerMimeType()

Returns the mime type used by the default serializer.

Returns:

the mime type of the default serializer

composeElement

void composeElement(String customSchemaElement,
 InferenceContext profile,
 ICustomElementComposerContext context)

This method is called by the communication engine when a custom schema element is encountered and should be composed.

Parameters:

customSchemaElement - The name of the custom schema element, never null.

profile - The current profile context, never null

context - The custom element composer context that should be used to compose the custom element, never null

composeElement

DataValue composeElement(IElementReference customSchemaElement,
 InferenceContext profile)

This method is called by the communication engine when a custom schema element is encountered and should be composed.

Parameters:

customSchemaElement - - the IElementReference of the custom schema, never null

profile - - The current profile context, never null

Returns:

the data value representing the composed custom schema element