Package com.aquima.interactions.portal.model.session

Class CommunicationEngineHandler

java.lang.Object

com.aquima.interactions.portal.model.session.CommunicationEngineHandler

All Implemented Interfaces:

ICommunicationEngineHandler, ISystemMessagesHandler

public final class CommunicationEngineHandler
extends Object
implements ICommunicationEngineHandler

Internal communication engine handler to delegate calls to dynamic schema element with a portal engine context.

Since:

9.0

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommunicationEngineHandler(IInternalPortalContext context)

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 composerContext)	This method is called by the communication engine when a custom schema element is encountered and should be composed.
boolean	containsMessage(String id)	This method will check if a message exists for the specified id.
String	getDefaultSerializerMimeType()	Returns the mime type used by the default serializer.
IMultilingualText	getMessage(String id)	This method returns the message object belonging to the specified id.
IMultilingualText	getMessage(String id, String... parameters)	This method returns the message object belonging to the specified id.
IDataSerializer	getSerializer(String mimeType)	Returns a serializer for the specified mime type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CommunicationEngineHandler

protected CommunicationEngineHandler(IInternalPortalContext context)

Method Details

composeElement

public void composeElement(String customSchemaElement,
 InferenceContext profile,
 ICustomElementComposerContext composerContext)

Description copied from interface: ICommunicationEngineHandler

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

Specified by:

composeElement in interface ICommunicationEngineHandler

Parameters:

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

profile - The current profile context, never null

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

composeElement

public DataValue composeElement(IElementReference customSchemaElement,
 InferenceContext profile)

Description copied from interface: ICommunicationEngineHandler

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

Specified by:

composeElement in interface ICommunicationEngineHandler

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

getSerializer

public IDataSerializer getSerializer(String mimeType)

Description copied from interface: ICommunicationEngineHandler

Returns a serializer for the specified mime type.

Specified by:

getSerializer in interface ICommunicationEngineHandler

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

public String getDefaultSerializerMimeType()

Description copied from interface: ICommunicationEngineHandler

Returns the mime type used by the default serializer.

Specified by:

getDefaultSerializerMimeType in interface ICommunicationEngineHandler

Returns:

the mime type of the default serializer

containsMessage

public boolean containsMessage(String id)

Description copied from interface: ISystemMessagesHandler

This method will check if a message exists for the specified id. The id is not case sensitive.

Specified by:

containsMessage in interface ISystemMessagesHandler

Parameters:

id - String containing the name (id)

Returns:

Boolean indicating if a message is defined for the specified id.

getMessage

public IMultilingualText getMessage(String id)

Description copied from interface: ISystemMessagesHandler

This method returns the message object belonging to the specified id. When no message could be found for the given id an UnknownMessageException is thrown.

Specified by:

getMessage in interface ISystemMessagesHandler

Parameters:

id - Identifier of the message that is requested.

Returns:

Message object for the specified id.

getMessage

public IMultilingualText getMessage(String id,
 String... parameters)

Description copied from interface: ISystemMessagesHandler

This method returns the message object belonging to the specified id. With parameters. these parameters are inserted in the message, when the message string contains {} expressions. For example: a message definition of test=Test message with 3 parameters namely: {0}, {1} and {2} will result in the expanded message. When no message could be found for the given id an UnknownMessageException is thrown.

Specified by:

getMessage in interface ISystemMessagesHandler

Parameters:

id - Identifier of the message that is requested.

parameters - Array of parameter values that should be used in the message.

Returns:

Message object for the specified id.