Package com.aquima.interactions.process.ds

Interface IMessageEventMappingDS

All Superinterfaces:

IReportingDS

All Known Subinterfaces:

IIntermediateMessageEventMappingDS, IProcessEventStartDS

All Known Implementing Classes:

XmlIntermediateMessageEventMappingDS, XmlMessageEventMappingDS, XmlProcessEventStartDS

public interface IMessageEventMappingDS
extends IReportingDS

This interface represents a data field of a message event mapping.

Since:

9.1

Author:

B. van de Ven

Method Summary

Modifier and Type	Method	Description
String	getMatchOnField()	This method return the matching field selected
String	getMessageEventName()	This method returns the name of the message event, may not be null.
TargetInstanceType	getTargetInstanceType()	This method returns the target instance Possible values: Singleton(s)/ Select Existing Instance
void	iterateFields(IMessageEventMappingFieldVisitor visitor)	This method should iterate about all the mapped fields of the message event.

Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

addMessage

Method Details

getMessageEventName

String getMessageEventName()

This method returns the name of the message event, may not be null.

Returns:

The name of the message event, never null.

iterateFields

void iterateFields(IMessageEventMappingFieldVisitor visitor)
            throws InitializationException

This method should iterate about all the mapped fields of the message event.

Parameters:

visitor - The visitor that should be used to add the items to.

Throws:

InitializationException - This exception is thrown if the message event mapping can not be initialized.

getTargetInstanceType

TargetInstanceType getTargetInstanceType()

This method returns the target instance Possible values: Singleton(s)/ Select Existing Instance

Returns:

the target instance type

getMatchOnField

String getMatchOnField()

This method return the matching field selected

Returns:

matching field