com.sap.cds.services.draft

Interface DraftPrepareEventContext

All Superinterfaces:

EventContext

public interface DraftPrepareEventContext
extends EventContext

The EventContext for the DraftService.EVENT_DRAFT_PREPARE event.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIDE_EFFECTS_QUALIFIER

Method Summary

Modifier and Type	Method and Description
static DraftPrepareEventContext	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.
String	getSideEffectsQualifier()
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_DRAFT_PREPARE event
void	setSideEffectsQualifier(String sideEffectsQualifier) Sets the sideEffectQualifier

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

as, create, create, get, getCdsRuntime, getChangeSetContext, getEvent, getMessages, getModel, getParameterInfo, getServiceCatalog, getTarget, getUserInfo, isCompleted, put, setCompleted

Field Detail

SIDE_EFFECTS_QUALIFIER

static final String SIDE_EFFECTS_QUALIFIER

See Also:

Constant Field Values

Method Detail

create

static DraftPrepareEventContext create(String entityName)

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

Parameters:

entityName - the name of the entity

Returns:

the DraftPrepareEventContext

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

setSideEffectsQualifier

@CdsName(value="SideEffectsQualifier")
void setSideEffectsQualifier(String sideEffectsQualifier)

Sets the sideEffectQualifier

Parameters:

sideEffectsQualifier - the side effects qualifier

getSideEffectsQualifier

@CdsName(value="SideEffectsQualifier")
String getSideEffectsQualifier()

Returns:

the side effects qualifier

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_DRAFT_PREPARE event

setResult

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

Sets the result of the DraftService.EVENT_DRAFT_PREPARE event

Parameters:

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