Package com.sap.cds.services.changeset

Interface ChangeSetContext

All Known Subinterfaces:

ChangeSetContextSPI

public interface ChangeSetContext

A ChangeSetContext defines the transactional boundaries around one or multiple Service.emit(com.sap.cds.services.EventContext) calls. It can be used by Handler or other participants to ensure that changes, which were done as part of a ChangeSetContext are canceled (rolled back).
In addition it provides the ability to perform actions at the end of a ChangeSet by registering a ChangeSetListener

Method Summary

Modifier and Type	Method	Description
static ChangeSetContext	getCurrent()	Gives access to the currently active ChangeSetContext.
int	getId()
static boolean	isActive()
boolean	isMarkedForCancel()
void	markForCancel()	Marks the ChangeSetContext to be cancelled.
void	register(ChangeSetListener listener)	Registers a ChangeSetListener on the ChangeSetContext, to be notified once the ChangeSetContext is closed successfully or cancelled.

Method Details

isActive

static boolean isActive()

Returns:

true, if a ChangeSetContext is currently active

getCurrent

static ChangeSetContext getCurrent()

Gives access to the currently active ChangeSetContext. If no ChangeSetContext is currently opened this method will return null

Returns:

the currently active ChangeSetContext or null.

getId

int getId()

Returns:

an numeric identifier of the ChangeSetContext, used for logging

markForCancel

void markForCancel()

Marks the ChangeSetContext to be cancelled. When the ChangeSet is finished, transactions will be rolled back.

isMarkedForCancel

boolean isMarkedForCancel()

Returns:

true, if markForCancel() was called at least once, false otherwise

register

void register(ChangeSetListener listener)

Registers a ChangeSetListener on the ChangeSetContext, to be notified once the ChangeSetContext is closed successfully or cancelled.

Parameters:

listener - the ChangeSetListener