Annotation Interface DataMethodQuery

@Retention(RUNTIME) @Target({METHOD,ANNOTATION_TYPE}) @Internal @Inherited public @interface DataMethodQuery
Internal annotation used describe the stored query definition.
Since:
4.10
Author:
Denis Stepanov

  • Field Details

    • NAME

      static final String NAME
      The annotation name.

    • META_MEMBER_QUERY

      static final String META_MEMBER_QUERY
      The member that holds the query value.
      See Also:

    • META_MEMBER_NATIVE

      static final String META_MEMBER_NATIVE
      The member that holds the native query value.
      See Also:

    • META_MEMBER_RAW_QUERY

      static final String META_MEMBER_RAW_QUERY
      Whether the user is a raw user specified query.
      See Also:

    • META_MEMBER_PROCEDURE

      static final String META_MEMBER_PROCEDURE
      The member that holds the is procedure value.
      See Also:

    • META_MEMBER_EXPANDABLE_QUERY

      static final String META_MEMBER_EXPANDABLE_QUERY
      The member that holds expandable query parts.
      See Also:

    • META_MEMBER_RESULT_TYPE

      static final String META_MEMBER_RESULT_TYPE
      The member name that holds the result type.
      See Also:

    • META_MEMBER_RESULT_DATA_TYPE

      static final String META_MEMBER_RESULT_DATA_TYPE
      The member name that holds the result type.
      See Also:

    • META_MEMBER_OFFSET

      static final String META_MEMBER_OFFSET
      The parameter that holds the offset value.
      See Also:

    • META_MEMBER_LIMIT

      static final String META_MEMBER_LIMIT
      The parameter that holds the limit value.
      See Also:

    • META_MEMBER_SORT

      static final String META_MEMBER_SORT
      The parameter that holds the order value.
      See Also:

    • META_MEMBER_DTO

      static final String META_MEMBER_DTO
      Does the query result in a DTO object.
      See Also:

    • META_MEMBER_OPTIMISTIC_LOCK

      static final String META_MEMBER_OPTIMISTIC_LOCK
      Does the query contains optimistic lock.
      See Also:

    • META_MEMBER_PARAMETERS

      static final String META_MEMBER_PARAMETERS
      Meta member for storing the parameters.
      See Also:

    • META_MEMBER_OPERATION_TYPE

      static final String META_MEMBER_OPERATION_TYPE
      The member name that holds the root entity type.
      See Also:

    • META_MEMBER_PARAMETERS_TYPE_ROLES

      static final String META_MEMBER_PARAMETERS_TYPE_ROLES
      The member name that holds the type roles if parameters.
      See Also:

    • META_MEMBER_RETURN_TYPE_ROLE

      static final String META_MEMBER_RETURN_TYPE_ROLE
      The member name that holds the type role of the return type.
      See Also:

  • Element Details

    • resultType

      Class<?> resultType
      The computed result type. This represents the type that is to be read from the database. For example for a List this would return the value of the generic type parameter E. Or for an entity result the return type itself.
      Returns:
      The result type
      Default:
      void.class

    • resultDataType

      DataType resultDataType
      Returns:
      The result data type.
      Default:
      OBJECT

    • parameters

      DataMethodQueryParameter[] parameters
      Returns:
      The query parameters
      Default:
      {}

    • procedure

      boolean procedure
      Returns:
      True if the method represents the procedure invocation.
      Since:
      4.2.0
      Default:
      false