Interface SqmParameter<T>

    • Method Detail

      • getName

        String getName()
        If this represents a named parameter, return that parameter name; otherwise return null.
        Specified by:
        getName in interface jakarta.persistence.Parameter<T>
        Returns:
        The parameter name, or null if not a named parameter
      • getPosition

        Integer getPosition()
        If this represents a positional parameter, return that parameter position; otherwise return null.
        Specified by:
        getPosition in interface jakarta.persistence.Parameter<T>
        Returns:
        The parameter position
      • allowMultiValuedBinding

        boolean allowMultiValuedBinding()
        Can a collection/array of values be bound to this parameter?

        This is allowed in very limited contexts within the query:

        1. as the value of an IN predicate if the only value is a single param
        2. (in non-strict JPA mode) as the final vararg to a function
        Returns:
        true if binding collection/array of values is allowed for this parameter; false otherwise.
      • getAnticipatedType

        AllowableParameterType<T> getAnticipatedType()
        Based on the context it is declared, what is the anticipated type for bind values?

        NOTE: If allowMultiValuedBinding() is true, this will indicate the Type of the individual values.

        Returns:
        The anticipated Type.