io.micronaut.data.annotation

Annotation Type TypeRole

@Retention(value=RUNTIME)
 @Target(value={METHOD,FIELD,ANNOTATION_TYPE})
 @Documented
 @Inherited
public @interface TypeRole

A type role indicates a method element in a repository that plays a role in query execution and should not be factored into query calculation but instead made available at runtime using the specified role name.

This is used for example to configure a Pageable object to be handled differently to other query arguments.

The parameter names of each role can be resolved from the MethodInvocationContext as a member of the DataMethod annotation where the member name is the role name.

Since:

1.0.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	ENTITIES The parameter that defines an iterable of the entity instances.
static java.lang.String	ENTITY The parameter that defines an instance of the entity.
static java.lang.String	ID The parameter that is used for the ID of entity.
static java.lang.String	LAST_UPDATED_PROPERTY Deprecated.
static java.lang.String	PAGE The parameter that is used to represent a Page.
static java.lang.String	PAGEABLE The parameter that is used for pagination.
static java.lang.String	SLICE The parameter that is used to represent a Slice.
static java.lang.String	SORT The parameter that is used for sorting.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	role The name of the role.
java.lang.Class<?>	type The parameter type.

Field Detail

PAGEABLE

public static final java.lang.String PAGEABLE

The parameter that is used for pagination.

SORT

public static final java.lang.String SORT

The parameter that is used for sorting.

ID

public static final java.lang.String ID

The parameter that is used for the ID of entity.

ENTITY

public static final java.lang.String ENTITY

The parameter that defines an instance of the entity.

ENTITIES

public static final java.lang.String ENTITIES

The parameter that defines an iterable of the entity instances.

LAST_UPDATED_PROPERTY

@Deprecated
public static final java.lang.String LAST_UPDATED_PROPERTY

Deprecated.

The last updated property of the entity for an update operation.

SLICE

public static final java.lang.String SLICE

The parameter that is used to represent a Slice.

PAGE

public static final java.lang.String PAGE

The parameter that is used to represent a Page.

Element Detail

role

public abstract java.lang.String role

The name of the role.

Returns:

The role name

type

public abstract java.lang.Class<?> type

The parameter type.

Returns:

The parameter type