eu.ehri.project.models.annotations

Annotation Type Fetch

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

Marks the entity pointed to by the framed Adjacency as one that should typically be fetched and displayed along with the master object.

Field Summary

Fields

Modifier and Type	Fields and Description
static int	DEFAULT_TRAVERSALS

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The name of the relation when serialized.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	full Always serialize in full mode, regardless of whether lite serialization is enabled.
int	ifBelowLevel Only serialize this relationship if the depth of traversal is below this value.
int	ifLevel Only traverse this relationship at the specified level.
int	numLevels The number of levels this relationship should traverse from the current item.
boolean	whenNotLite Only serialize this relation when not serializing in 'lite' mode.

Field Detail

DEFAULT_TRAVERSALS

public static final int DEFAULT_TRAVERSALS

Element Detail

value

public abstract String value

The name of the relation when serialized.

Returns:

the relation name

ifBelowLevel

public abstract int ifBelowLevel

Only serialize this relationship if the depth of traversal is below this value. The default value is 10.

Returns:

the level below which this relationship should be traversed

Default:

10

ifLevel

public abstract int ifLevel

Only traverse this relationship at the specified level. Ignored if the level is less than 0.

Returns:

the level at which this relation should be traversed

Default:

-1

numLevels

public abstract int numLevels

The number of levels this relationship should traverse from the current item. i.e. if this item is at level N the serialization of it's relations should stop at level N + Fetch.numLevels().

Default:

-1

whenNotLite

public abstract boolean whenNotLite

Only serialize this relation when not serializing in 'lite' mode.

Returns:

to serialize or not

Default:

false

full

public abstract boolean full

Always serialize in full mode, regardless of whether lite serialization is enabled.

Returns:

override lite mode serialization

Default:

false