Package com.novomind.ecom.api.imail.core.result

Class IncomingMessageAnalyzerResult

java.lang.Object

com.novomind.ecom.api.imail.core.result.IncomingMessageAnalyzerResult

public final class IncomingMessageAnalyzerResult
extends Object

The IncomingMessageAnalyzerResult is the returned object of the extension point IncomingMessageAnalyzer. It contains all AnalyzerDecisions made during one call of analyzeIncomingMessage.

Since:

11.15

Field Summary

Fields

Modifier and Type	Field	Description
static final IncomingMessageAnalyzerResult	UNMODIFIED	An IncomingMessageAnalyzerResult which contains no AnalyzerDecisions. Adding Decisions to this shared instance will throw an UnsupportedOperationException

Constructor Summary

Constructors

Constructor	Description
IncomingMessageAnalyzerResult()	Constructs a new IncomingMessageAnalyzerResult with no decisions.

Method Summary

Modifier and Type	Method	Description
IncomingMessageAnalyzerResult	addCategoryDecision(CategoryAnalyzerDecision decision)	Adds a CategoryAnalyzerDecision to this IncomingMessageAnalyzerResult even if the Set already contains an equal CategoryAnalyzerDecision.
IncomingMessageAnalyzerResult	addConfirmationTemplateDecision(TemplateAnalyzerDecision decision)	Adds a TemplateAnalyzerDecision for confirmation templates to this IncomingMessageAnalyzerResult even if the Set already contains an equal TemplateAnalyzerDecision.
IncomingMessageAnalyzerResult	addContactAnalyzerDecision(ContactAnalyzerDecision decision)	Adds a ContactAnalyzerDecision to this IncomingMessageAnalyzerResult even if the Set already contains an equal ContactAnalyzerDecision.
IncomingMessageAnalyzerResult	addLanguageDecision(LanguageAnalyzerDecision decision)	Adds a LanguageAnalyzerDecision to this IncomingMessageAnalyzerResult even if the Set already contains an equal LanguageAnalyzerDecision.
IncomingMessageAnalyzerResult	addLocationDecision(LocationAnalyzerDecision decision)	Adds a LocationAnalyzerDecision to this IncomingMessageAnalyzerResult even if the Set already contains an equal LocationAnalyzerDecision.
IncomingMessageAnalyzerResult	addRoutingTagDecision(RoutingTagAnalyzerDecision decision)	Adds a RoutingTagAnalyzerDecision to this IncomingMessageAnalyzerResult even if the Set already contains an equal RoutingTagAnalyzerDecision.
IncomingMessageAnalyzerResult	addSuggestionTemplateDecision(TemplateAnalyzerDecision decision)	Adds a TemplateAnalyzerDecision for suggestion templates to this IncomingMessageAnalyzerResult even if the Set already contains an equal TemplateAnalyzerDecision.
SortedSet<CategoryAnalyzerDecision>	getCategoryDecisions()	Returns the sorted set of category analyzer decisions.
SortedSet<TemplateAnalyzerDecision>	getConfirmationTemplateDecisions()	Returns the sorted set of template analyzer decisions for confirmation templates.
SortedSet<ContactAnalyzerDecision>	getContactAnalyzerDecisions()	Returns the sorted set of contact analyzer decisions.
SortedSet<LanguageAnalyzerDecision>	getLanguageDecisions()	Returns the sorted set of language analyzer decisions.
SortedSet<LocationAnalyzerDecision>	getLocationDecisions()	Returns the sorted set of location analyzer decisions.
SortedSet<RoutingTagAnalyzerDecision>	getRoutingTagDecisions()	Returns the sorted set of routing tag analyzer decisions.
SortedSet<TemplateAnalyzerDecision>	getSuggestionTemplateDecisions()	Returns the sorted set of template analyzer decisions for suggestion templates.
boolean	isUnmodified()	Returns true if this instance is the shared UNMODIFIED result.

Methods inherited from class java.lang.Object

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

Field Details

UNMODIFIED

public static final IncomingMessageAnalyzerResult UNMODIFIED

An IncomingMessageAnalyzerResult which contains no AnalyzerDecisions.
Adding Decisions to this shared instance will throw an UnsupportedOperationException

Since:

11.15

Constructor Details

IncomingMessageAnalyzerResult

public IncomingMessageAnalyzerResult()

Constructs a new IncomingMessageAnalyzerResult with no decisions.

Since:

11.15

Method Details

isUnmodified

public boolean isUnmodified()

Returns true if this instance is the shared UNMODIFIED result.

Returns:

true if this instace is an UNMODIFIED Result

Since:

11.15

addCategoryDecision

public IncomingMessageAnalyzerResult addCategoryDecision(CategoryAnalyzerDecision decision)

Adds a CategoryAnalyzerDecision to this IncomingMessageAnalyzerResult even if the Set already contains an equal CategoryAnalyzerDecision.

Parameters:

decision - a CategoryAnalyzerDecision

Returns:

the instance for fluent usage

Since:

11.15

addLanguageDecision

public IncomingMessageAnalyzerResult addLanguageDecision(LanguageAnalyzerDecision decision)

Adds a LanguageAnalyzerDecision to this IncomingMessageAnalyzerResult even if the Set already contains an equal LanguageAnalyzerDecision.

Parameters:

decision - a LanguageAnalyzerDecision

Returns:

the instance for fluent usage

Since:

11.15

addLocationDecision

public IncomingMessageAnalyzerResult addLocationDecision(LocationAnalyzerDecision decision)

Adds a LocationAnalyzerDecision to this IncomingMessageAnalyzerResult even if the Set already contains an equal LocationAnalyzerDecision.

Parameters:

decision - a LocationAnalyzerDecision

Returns:

the instance for fluent usage

Since:

11.15

addRoutingTagDecision

public IncomingMessageAnalyzerResult addRoutingTagDecision(RoutingTagAnalyzerDecision decision)

Adds a RoutingTagAnalyzerDecision to this IncomingMessageAnalyzerResult even if the Set already contains an equal RoutingTagAnalyzerDecision.

Parameters:

decision - a RoutingTagAnalyzerDecision

Returns:

the instance for fluent usage

Since:

13.2

addSuggestionTemplateDecision

public IncomingMessageAnalyzerResult addSuggestionTemplateDecision(TemplateAnalyzerDecision decision)

Adds a TemplateAnalyzerDecision for suggestion templates to this IncomingMessageAnalyzerResult even if the Set already contains an equal TemplateAnalyzerDecision.

Parameters:

decision - a TemplateAnalyzerDecision

Returns:

the instance for fluent usage

Since:

12.31

addConfirmationTemplateDecision

public IncomingMessageAnalyzerResult addConfirmationTemplateDecision(TemplateAnalyzerDecision decision)

Adds a TemplateAnalyzerDecision for confirmation templates to this IncomingMessageAnalyzerResult even if the Set already contains an equal TemplateAnalyzerDecision.

Parameters:

decision - a TemplateAnalyzerDecision

Returns:

the instance for fluent usage

Since:

12.31

addContactAnalyzerDecision

public IncomingMessageAnalyzerResult addContactAnalyzerDecision(ContactAnalyzerDecision decision)

Adds a ContactAnalyzerDecision to this IncomingMessageAnalyzerResult even if the Set already contains an equal ContactAnalyzerDecision.

Parameters:

decision - a TemplateAnalyzerDecision

Returns:

the instance for fluent usage

Since:

12.41

getCategoryDecisions

public SortedSet<CategoryAnalyzerDecision> getCategoryDecisions()

Returns the sorted set of category analyzer decisions.

Returns:

the SortedSet of CategoryAnalyzerDecisions

Since:

11.15

getLanguageDecisions

public SortedSet<LanguageAnalyzerDecision> getLanguageDecisions()

Returns the sorted set of language analyzer decisions.

Returns:

the SortedSet of LanguageAnalyzerDecisions

Since:

11.15

getLocationDecisions

public SortedSet<LocationAnalyzerDecision> getLocationDecisions()

Returns the sorted set of location analyzer decisions.

Returns:

the SortedSet of LocationAnalyzerDecisions

Since:

11.15

getRoutingTagDecisions

public SortedSet<RoutingTagAnalyzerDecision> getRoutingTagDecisions()

Returns the sorted set of routing tag analyzer decisions.

Returns:

the SortedSet of RoutingTagAnalyzerDecisions

Since:

13.2

getSuggestionTemplateDecisions

public SortedSet<TemplateAnalyzerDecision> getSuggestionTemplateDecisions()

Returns the sorted set of template analyzer decisions for suggestion templates.

Returns:

the SortedSet of TemplateAnalyzerDecisions for the suggestion template

Since:

12.31

getConfirmationTemplateDecisions

public SortedSet<TemplateAnalyzerDecision> getConfirmationTemplateDecisions()

Returns the sorted set of template analyzer decisions for confirmation templates.

Returns:

the SortedSet of TemplateAnalyzerDecisions for the confirmation template

Since:

12.31

getContactAnalyzerDecisions

public SortedSet<ContactAnalyzerDecision> getContactAnalyzerDecisions()

Returns the sorted set of contact analyzer decisions.

Returns:

the SortedSet of ContactAnalyzerDecisions

Since:

12.41