org.sormula.annotation.cascade

Annotation Type DeleteCascade

@Retention(value=RUNTIME)
 @Target(value={FIELD,ANNOTATION_TYPE})
public @interface DeleteCascade

Used within a Cascade annotation to define a cascade delete operation.

Since:

1.0

Author:

Jeff Miller

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<? extends DeleteOperation>	operation Specifies operation to perform as a delete cascade.
boolean	post Specifies when the cascade is to occur.
boolean	setForeignKeyReference Indicates that foreign key reference should be set on target (child) rows during cascade.
boolean	setForeignKeyValues Indicates that foreign key values should be set on target (child) rows during cascade.

Element Detail

operation

public abstract java.lang.Class<? extends DeleteOperation> operation

Specifies operation to perform as a delete cascade. Typically it is DeleteOperation. Use subclass of DeleteOperation to customize the delete cascade.

Returns:

operation to use for cascade

Default:

org.sormula.operation.DeleteOperation.class

post

public abstract boolean post

Specifies when the cascade is to occur. Note that default is false which is the inverse of other cascade annotations since child row deletes typically occur prior to parent row to maintain foreign key constraints.

Returns:

true to perform cascade after source row operation; false to perform cascade before source row operation

Default:

false

setForeignKeyValues

public abstract boolean setForeignKeyValues

Indicates that foreign key values should be set on target (child) rows during cascade. Foreign key value fields are defined by Cascade.foreignKeyValueFields(), OneToManyCascade.foreignKeyValueFields(), or OneToOneCascade.foreignKeyValueFields().

Foreign key values are set prior to cascade for insert, update, delete, and save cascades. They are set after select cascades.

Default is false for delete cascade since typically foreign keys are not needed when deleting.

Returns:

true to set foreign key values during cascade

Since:

3.0

Default:

false

setForeignKeyReference

public abstract boolean setForeignKeyReference

Indicates that foreign key reference should be set on target (child) rows during cascade. Foreign key reference field is defined by Cascade.foreignKeyReferenceField(), OneToManyCascade.foreignKeyReferenceField(), or OneToOneCascade.foreignKeyReferenceField().

Foreign key reference is set prior to cascade for insert, update, delete, and save cascades. It is set after select cascades.

Default is false for delete cascade since typically foreign keys are not needed when deleting.

Returns:

true to set foreign key reference during cascade

Since:

3.0

Default:

false