Package com.sap.cds.services.messaging

Interface MessagingErrorEventContext

All Superinterfaces:

EventContext

public interface MessagingErrorEventContext
extends EventContext

EventContext for the event MessagingService.EVENT_MESSAGING_ERROR, that allows to handle acknowledgement of a message on the messaging channel

Method Summary

Modifier and Type	Method	Description
static MessagingErrorEventContext	create()	Creates an EventContext already overlayed with this interface.
ServiceException	getException()
boolean	getResult()
void	setException(ServiceException exception)	Sets the ServiceException that was thrown while handling the message.
void	setResult(boolean acknowledge)	Determines whether the message should be acknowledged or not.

Methods inherited from interface com.sap.cds.services.EventContext

as, get, getAuthenticationInfo, getCdsRuntime, getChangeSetContext, getEvent, getFeatureTogglesInfo, getMessages, getModel, getParameterInfo, getService, getServiceCatalog, getTarget, getUserInfo, isCompleted, keySet, put, setCompleted

Method Details

create

static MessagingErrorEventContext create()

Creates an EventContext already overlayed with this interface. The event is set to be MessagingService.EVENT_MESSAGING_ERROR

Returns:

the MessagingErrorEventContext

setException

void setException(ServiceException exception)

Sets the ServiceException that was thrown while handling the message.

Parameters:

exception - the ServiceException that was thrown while handling the message.

getException

ServiceException getException()

Returns:

the ServiceException that caused the error during the message handling.

setResult

void setResult(boolean acknowledge)

Determines whether the message should be acknowledged or not.

Parameters:

acknowledge - true if the message should be acknowledged on the messaging channel and false otherwise.

getResult

boolean getResult()

Returns:

true if the message should be acknowledged on the messaging channel and false otherwise.