Package com.sap.cds.services.outbox

Interface OutboxMessage

All Superinterfaces:

com.sap.cds.CdsData, com.sap.cds.JSONizable, Map<String,Object>

public interface OutboxMessage
extends com.sap.cds.CdsData

Represents the default structure of a message stored in the outbox and handled generically. Additional information can be freely added to the underlying Map structure.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.cds.CdsData

com.sap.cds.CdsData.Factory

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVENT
static final String	PARAMS

Fields inherited from interface com.sap.cds.CdsData

factory

Method Summary

Modifier and Type	Method	Description
static OutboxMessage	create()	Creates a new OutboxMessage
String	getEvent()
Map<String,Object>	getParams()
void	setEvent(String event)	Sets the original event, to be stored in the outbox
void	setParams(Map<String,Object> data)	Sets the event context parameters of the original event

Methods inherited from interface com.sap.cds.CdsData

containsPath, forRemoval, forRemoval, get, getPath, getPathOrDefault, isForRemoval, putPath, putPathIfAbsent, removePath

Methods inherited from interface com.sap.cds.JSONizable

toJson

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Details

EVENT

static final String EVENT

See Also:

• Constant Field Values

PARAMS

static final String PARAMS

See Also:

• Constant Field Values

Method Details

create

static OutboxMessage create()

Creates a new OutboxMessage

Returns:

the OutboxMessage

getEvent

String getEvent()

Returns:

the original event stored in the outbox

setEvent

void setEvent(String event)

Sets the original event, to be stored in the outbox

Parameters:

event - the event

getParams

Map<String,Object> getParams()

Returns:

the event context parameters of the original event

setParams

void setParams(Map<String,Object> data)

Sets the event context parameters of the original event

Parameters:

data - the context parameters