org.apache.cayenne.lifecycle.audit

Annotation Type AuditableChild

@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@Inherited
public @interface AuditableChild

A built-in annotation used to tag an object that is not auditable on its own, but whose changes should be tracked together with changes of another ("parent") object. This annotation allows to group changes in a closely related subtree of objects. Either value() or objectIdRelationship() must be set to a non-empty String, so that a processor of AuditableChild could find the parent of the annotated object.

Since:

3.1

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	ignoredProperties
String	objectIdRelationship Returns the name of the property of the annotated entity of the relationship that stores a String "FK" of a related "parent" entity.
String	value Returns the name of a to-one relationship from an annotated object to the "parent" object that should be audited when annotated object is changed.

Element Detail

value

public abstract String value

Returns the name of a to-one relationship from an annotated object to the "parent" object that should be audited when annotated object is changed.

Default:

""

objectIdRelationship

public abstract String objectIdRelationship

Returns the name of the property of the annotated entity of the relationship that stores a String "FK" of a related "parent" entity.

Default:

""

ignoredProperties

public abstract String[] ignoredProperties

Default:

{}