org.oncoblocks.centromere.core.model

Annotation Type ForeignKey

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface ForeignKey

Marks a Model class field as being a foreign key identifier of another class. Allows for automatic generation of hypermedia links in web responses, based upon the inferred relationship and query string parameters.

Author:

woemler

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends Model<?>>	model The Model class that the foreign key field is referencing.
ForeignKey.Relationship	relationship ForeignKey.Relationship value that represents the entity relationship to the referenced class.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	field Query string parameter name to be used in the hypermedia link.
String	rel String name of the relationship to be used in hypermedia links.

Element Detail

model

public abstract Class<? extends Model<?>> model

The Model class that the foreign key field is referencing.

Returns:

relationship

public abstract ForeignKey.Relationship relationship

ForeignKey.Relationship value that represents the entity relationship to the referenced class.

Returns:

rel

public abstract String rel

String name of the relationship to be used in hypermedia links. By default, the field name is used.

Returns:

Default:

""

field

public abstract String field

Query string parameter name to be used in the hypermedia link. By default, the field name is used.

Returns:

Default:

""