Package com.sap.cds.services.draft

Interface ActiveReadEventContext

All Superinterfaces:

EventContext

public interface ActiveReadEventContext
extends EventContext

The EventContext for the DraftService.EVENT_ACTIVE_READ event

Method Summary

Modifier and Type	Method	Description
static ActiveReadEventContext	create(String entityName)	Creates an EventContext already overlayed with this interface.
com.sap.cds.ql.cqn.CqnSelect	getCqn()
Map<String,Object>	getCqnNamedValues()	The CQN named values, for parameterized CqnSelect statements
com.sap.cds.Result	getResult()
DraftService	getService()	Returns the Service (Consumption API) of the service, targeted by the EventContext.
void	setCqn(com.sap.cds.ql.cqn.CqnSelect cqn)	Sets the CqnSelect statement
void	setCqnNamedValues(Map<String,Object> namedValues)	Sets the CQN named values, for parameterized CqnSelect statements
void	setResult(Iterable<? extends Map<String,?>> result)	Sets the result of the DraftService.EVENT_ACTIVE_READ event

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 ActiveReadEventContext create(String entityName)

Creates an EventContext already overlayed with this interface. The event is set to be DraftService.EVENT_ACTIVE_READ

Parameters:

entityName - the name of the entity

Returns:

the ActiveReadEventContext

getService

DraftService 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.

getCqn

com.sap.cds.ql.cqn.CqnSelect getCqn()

Returns:

the CqnSelect statement

setCqn

void setCqn(com.sap.cds.ql.cqn.CqnSelect cqn)

Sets the CqnSelect statement

Parameters:

cqn - the CqnSelect statement

getCqnNamedValues

Map<String,Object> getCqnNamedValues()

The CQN named values, for parameterized CqnSelect statements

Returns:

the CQN named values

setCqnNamedValues

void setCqnNamedValues(Map<String,Object> namedValues)

Sets the CQN named values, for parameterized CqnSelect statements

Parameters:

namedValues - the CQN named values

getResult

com.sap.cds.Result getResult()

Returns:

the Result of the DraftService.EVENT_ACTIVE_READ event

setResult

void setResult(Iterable<? extends Map<String,?>> result)

Sets the result of the DraftService.EVENT_ACTIVE_READ event

Parameters:

result - a Result or a list of Maps, which will be transformed into a Result