Package com.sap.cds.services.mt

Interface SubscribeEventContext

All Superinterfaces:

EventContext

public interface SubscribeEventContext
extends EventContext

Method Summary

Modifier and Type	Method	Description
static SubscribeEventContext	create()	Creates an EventContext already overlayed with this interface.
Map<String,Object>	getOptions()	To get named and type safe access to this options map, it's possible to cast it to a specific implementation.
DeploymentService	getService()	Returns the Service (Consumption API) of the service, targeted by the EventContext.
String	getTenant()
void	setOptions(Map<String,Object> options)	Sets the optional additional options
void	setTenant(String tenant)	Sets the tenant ID

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

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

Method Details

create

static SubscribeEventContext create()

Creates an EventContext already overlayed with this interface. The event is set to be DeploymentService.EVENT_SUBSCRIBE

Returns:

the SubscribeEventContext

getService

DeploymentService getService()

Description copied from interface: EventContext

Returns the Service (Consumption API) of the service, targeted by the EventContext. This is the service, on which the Service.emit(EventContext) method (or specialized Consumption API) was called.

Specified by:

getService in interface EventContext

Returns:

the Service (Consumption API) of the service, targeted by the EventContext.

getTenant

String getTenant()

Returns:

the tenant ID

setTenant

void setTenant(String tenant)

Sets the tenant ID

Parameters:

tenant - the tenant ID

getOptions

Map<String,Object> getOptions()

To get named and type safe access to this options map, it's possible to cast it to a specific implementation. For example, to access the SaaS registry payload it can be converted to SaasRegistrySubscriptionOptions:

 SaasRegistrySubscriptionOptions.create(context.getOptions());
 

Returns:

the optional additional options

setOptions

void setOptions(Map<String,Object> options)

Sets the optional additional options

Parameters:

options - the optional additional options