com.yahoo.elide.annotation

Annotation Type LifeCycleHookBinding

@Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
 @Repeatable(value=LifeCycleHookBindings.class)
public @interface LifeCycleHookBinding

Executes arbitrary logic (a lifecycle hook) when an Elide model is read or written.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends LifeCycleHook>	hook The function to invoke when this life cycle triggers.
LifeCycleHookBinding.Operation	operation Which CRUD operation to trigger on.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	oncePerRequest Controls how often the hook is invoked: A hook is invoked once per class per request (when bound to the model).
LifeCycleHookBinding.TransactionPhase	phase Which transaction phase to trigger on.

Element Detail

hook

public abstract Class<? extends LifeCycleHook> hook

The function to invoke when this life cycle triggers.

Returns:

the function class.

operation

public abstract LifeCycleHookBinding.Operation operation

Which CRUD operation to trigger on.

Returns:

CREATE, READ, UPDATE, or DELETE

phase

public abstract LifeCycleHookBinding.TransactionPhase phase

Which transaction phase to trigger on.

Returns:

PRESECURITY, PRECOMMIT, or POSTCOMMIT

Default:

com.yahoo.elide.annotation.LifeCycleHookBinding.TransactionPhase.PRECOMMIT

oncePerRequest

public abstract boolean oncePerRequest

Controls how often the hook is invoked: A hook is invoked once per class per request (when bound to the model). A hook is invoked once per field per request (when bound to a model field or method). A hook is invoked one or more times per class per request (when bound to a model and oncePerRequest is false).

Returns:

true or false.

Default:

true