com.sap.cds.services

Class ServiceDelegator

java.lang.Object

com.sap.cds.services.ServiceDelegator

All Implemented Interfaces:

Service

public abstract class ServiceDelegator
extends Object
implements Service

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceDelegator(String name)

Method Summary

Modifier and Type	Method and Description
void	after(EventPredicate matcher, Handler handler) Deprecated.
void	after(String[] events, String[] entities, int order, Handler handler) Registers a Handler on this Service for the AFTER phase of the processing of an EventContext.
void	before(EventPredicate matcher, Handler handler) Deprecated.
void	before(String[] events, String[] entities, int order, Handler handler) Registers a Handler on this Service for the BEFORE phase of the processing of an EventContext.
void	emit(EventContext context) The generic consumption API to emit arbitrary events, represented by EventContext objects.
Service	getDelegatedService()
String	getName() Returns the name of the Service.
void	on(EventPredicate matcher, Handler handler) Deprecated.
void	on(String[] events, String[] entities, int order, Handler handler) Registers a Handler on this Service for the ON phase of the processing of an EventContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

after, after, after, before, before, before, create, on, on, on

Constructor Detail

ServiceDelegator

protected ServiceDelegator(String name)

Method Detail

before

@Deprecated
public void before(EventPredicate matcher,
                               Handler handler)

Deprecated.

Description copied from interface: Service

Registers a Handler on this Service for the BEFORE phase of the processing of an EventContext.

Specified by:

before in interface Service

Parameters:

matcher - the EventPredicate, defining for which events and entities the Handler becomes active.

handler - the Handler implementing the business-logic, which should become active during the BEFORE phase.

before

public void before(String[] events,
                   String[] entities,
                   int order,
                   Handler handler)

Description copied from interface: Service

Registers a Handler on this Service for the BEFORE phase of the processing of an EventContext.

Specified by:

before in interface Service

Parameters:

events - the events the custom handler is registered for

entities - the entities the custom handler is registered for

order - the order of the handler. the lower the order the earlier the handler gets called. if two handlers have the same order they get ordered in their registration order

handler - the Handler implementing the business-logic, which should become active during the BEFORE phase.

on

@Deprecated
public void on(EventPredicate matcher,
                           Handler handler)

Deprecated.

Description copied from interface: Service

Registers a Handler on this Service for the ON phase of the processing of an EventContext.

Specified by:

on in interface Service

Parameters:

matcher - the EventPredicate, defining for which events and entities the Handler becomes active.

handler - the Handler implementing the business-logic, which should become active during the ON phase.

on

public void on(String[] events,
               String[] entities,
               int order,
               Handler handler)

Description copied from interface: Service

Registers a Handler on this Service for the ON phase of the processing of an EventContext.

Specified by:

on in interface Service

Parameters:

events - the events the custom handler is registered for

entities - the entities the custom handler is registered for

order - the order of the handler. the lower the order the earlier the handler gets called. if two handlers have the same order they get ordered in their registration order

handler - the Handler implementing the business-logic, which should become active during the ON phase.

after

@Deprecated
public void after(EventPredicate matcher,
                              Handler handler)

Deprecated.

Description copied from interface: Service

Registers a Handler on this Service for the AFTER phase of the processing of an EventContext.

Specified by:

after in interface Service

Parameters:

matcher - the EventPredicate, defining for which events and entities the Handler becomes active.

handler - the Handler implementing the business-logic, which should become active during the AFTER phase.

after

public void after(String[] events,
                  String[] entities,
                  int order,
                  Handler handler)

Description copied from interface: Service

Registers a Handler on this Service for the AFTER phase of the processing of an EventContext.

Specified by:

after in interface Service

Parameters:

events - the events the custom handler is registered for

entities - the entities the custom handler is registered for

order - the order of the handler. the lower the order the earlier the handler gets called. if two handlers have the same order they get ordered in their registration order

handler - the Handler implementing the business-logic, which should become active during the AFTER phase.

emit

public void emit(EventContext context)

Description copied from interface: Service

The generic consumption API to emit arbitrary events, represented by EventContext objects. More specialized consumption APIs (for example CdsService) are implemented as a wrapper around this method.
Emitting an EventContext will start the processing of the event and calls the registered Handler instances. If Service.emit(EventContext) is called outside of an active ChangeSetContext, an internal ChangeSetContext is opened and properly closed. Handler can therefore rely on an active ChangeSetContext.
The EventContext passed to this method, should be propagated with the required input parameters of the event. After the method finished, the respective output parameters can be read from the passed in EventContext.

Specified by:

emit in interface Service

Parameters:

context - the EventContext to be emitted

getName

public String getName()

Description copied from interface: Service

Returns the name of the Service. The name might be the fully qualified name of a service, which is also present in the CdsModel. If the service is a technical service, the name is an arbitrary name, which is not reflected in the CdsModel.

Specified by:

getName in interface Service

Returns:

the name of the Service

getDelegatedService

public Service getDelegatedService()