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

Class DeliveryFailureMessageReceivedResult

java.lang.Object

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

public final class DeliveryFailureMessageReceivedResult
extends java.lang.Object

The DeliveryFailureMessageReceivedResult can be used to determine the handling of the delivery failure message by the novomind iAGENT system. Therefore the DeliveryFailureAction of the DeliveryFailureMessageReceivedResult has to be set appropriately.

Since:

11.27

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeliveryFailureMessageReceivedResult.DeliveryFailureAction	The DeliveryFailureAction specifies the different actions that are available in the novomind iAGENT system for the handling of delivery failure messages.

Constructor Summary

Constructors

Constructor	Description
DeliveryFailureMessageReceivedResult()	This constructor creates a new DeliveryFailureMessageReceivedResult with an empty DeliveryFailureAction.

Method Summary

Modifier and Type	Method	Description
java.util.Optional<DeliveryFailureMessageReceivedResult.DeliveryFailureAction>	getDeliveryFailureAction()	Returns the Optional DeliveryFailureAction of this DeliveryFailureMessageReceivedResult.
DeliveryFailureMessageReceivedResult.DeliveryFailureAction	setDeliveryFailureAction(DeliveryFailureMessageReceivedResult.DeliveryFailureAction deliveryFailureAction)	Sets the DeliveryFailureAction to this DeliveryFailureMessageReceivedResult.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeliveryFailureMessageReceivedResult

public DeliveryFailureMessageReceivedResult()

This constructor creates a new DeliveryFailureMessageReceivedResult with an empty DeliveryFailureAction. If the created DeliveryFailureMessageReceivedResult is returned directly, the delivery failure message will be processed as defined by the configuration of the novomind iAGENT system. By setting a DeliveryFailureAction to this DeliveryFailureMessageReceivedResult the action that takes place in the novomind iAGENT system can be changed.

Method Detail

setDeliveryFailureAction

public DeliveryFailureMessageReceivedResult.DeliveryFailureAction setDeliveryFailureAction(DeliveryFailureMessageReceivedResult.DeliveryFailureAction deliveryFailureAction)

Sets the DeliveryFailureAction to this DeliveryFailureMessageReceivedResult. The DeliveryFailureAction determines the further handling of the delivery failure message by the novomind iAGENT system. The action REACTIVATE_TICKET is only valid if this delivery failure message has a sent ticket associated. Setting a non applicable DeliveryFailureAction leads to error output in the log files of the novomind iAGENT system. The handling of the delivery failure will not be changed.

Parameters:

deliveryFailureAction - a DeliveryFailureMessageReceivedResult.DeliveryFailureAction

Returns:

the set DeliveryFailureAction

Since:

11.27

getDeliveryFailureAction

public java.util.Optional<DeliveryFailureMessageReceivedResult.DeliveryFailureAction> getDeliveryFailureAction()

Returns the Optional DeliveryFailureAction of this DeliveryFailureMessageReceivedResult. The DeliveryFailureAction determines the further handling of the delivery failure message by the novomind iAGENT system. By default the returned Optional is empty.

Returns:

an Optional with the delivery failure action, or an empty Optional if normal processing of the delivery failure message should take place.

Since:

11.27