com.sap.cds.services.handler.annotations

Annotation Type On

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface On

Annotation to register a handler for the ON phase of an event on a specific service and entity.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	entity Returns the array of entities the handler should handle.
String[]	event Returns the array of events the handler should handle.
String	service Returns the name of the service on which the handler should be registered.

Element Detail

event

public abstract String[] event

Returns the array of events the handler should handle. In case of an empty array or empty string the event definition is tried to be obtained from the arguments. For example a CdsCreateEventContext indicates a CdsService.EVENT_CREATE event. The string '*' is treated as wildcard and matches any event. If no event definition is provided, either via the annotation or via an argument an error is thrown.
Defaults to an empty array.

Returns:

the array of events the handler should handle

Default:

{}

entity

public abstract String[] entity

Returns the array of entities the handler should handle. In case of an empty array or empty string the entity definition is tried to be obtained from the arguments. For example a POJO argument, with CdsName annotation indicates a certain entity from the model. The string '*' is treated as wildcard and matches any entity. If no entity definition is explicitly provided, it defaults to a wildcard.
Defaults to an empty array.

Returns:

the array of entities the handler should handle.

Default:

{}

service

public abstract String service

Returns the name of the service on which the handler should be registered. If an empty string is given, the registration defaults to the ServiceName annotation given on class level.
Defaults to an empty string.

Returns:

the name of the service on which the handler should be registered.

Default:

""