Package io.micronaut.data.annotation

Annotation Interface TypeRole

@Retention(RUNTIME) @Target({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

  • Required Element Summary

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CURSORED_PAGE
    The parameter that is used to represent a CursoredPage.
    static final String
    ENTITIES
    The parameter that defines an iterable of the entity instances.
    static final String
    ENTITY
    The parameter that defines an instance of the entity.
    static final String
    ID
    The parameter that is used for the ID of entity.
    static final String
    PAGE
    The parameter that is used to represent a Page.
    static final String
    PAGEABLE
    The parameter that is used for pagination.
    static final String
    PAGEABLE_REQUIRED
    The parameter that is used for pageable which is no un-paged.
    static final String
    SLICE
    The parameter that is used to represent a Slice.
    static final String
    SORT
    The parameter that is used for sorting.