SpiDtoQuery (ebean 12.3.3 API)

All Superinterfaces:

DtoQuery<T>, SpiSqlBinding

All Known Implementing Classes:

DefaultDtoQuery
```
public interface SpiDtoQuery<T>
extends DtoQuery<T>, SpiSqlBinding
```
Internal extension to DtoQuery.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`DtoQueryPlan`	`buildPlan(DtoMappingRequest request)`	Build the query plan.
`String`	`getLabel()`	Return the label for the query.
`SpiQuery<?>`	`getOrmQuery()`	Return an underlying ORM query (if this query is built from an ORM query).
`String`	`getPlanLabel()`	Return the label with fallback to profile location label.
`ProfileLocation`	`getProfileLocation()`	Return the profile location.
`DtoQueryPlan`	`getQueryPlan(Object planKey)`	Get the query plan for the cache.
`Transaction`	`getTransaction()`	Return the explicit transaction used to execute the query.
`Class<T>`	`getType()`	Return the associated DTO bean type.
`boolean`	`isRelaxedMode()`	Return true if the query is in relaxed mapping mode.
`void`	`obtainLocation()`	Obtain the location if necessary.
`String`	`planKey()`	Return the key for query plan.
`void`	`putQueryPlan(Object planKey, DtoQueryPlan plan)`	Put the query plan into the cache.

Methods inherited from interface io.ebean.DtoQuery
findEach, findEachWhile, findList, findOne, findOneOrEmpty, setBufferFetchSizeHint, setFirstRow, setLabel, setMaxRows, setParameter, setParameter, setParameter, setParameters, setProfileLocation, setRelaxedMode, setTimeout, usingTransaction

Methods inherited from interface io.ebeaninternal.api.SpiSqlBinding
getBindParams, getBufferFetchSizeHint, getFirstRow, getMaxRows, getQuery, getTimeout

- Method Detail
  - planKey
```
String planKey()
```
    Return the key for query plan.
  - getQueryPlan
```
DtoQueryPlan getQueryPlan(Object planKey)
```
    Get the query plan for the cache.
  - buildPlan
```
DtoQueryPlan buildPlan(DtoMappingRequest request)
```
    Build the query plan.
  - putQueryPlan
```
void putQueryPlan(Object planKey,
                  DtoQueryPlan plan)
```
    Put the query plan into the cache.
  - isRelaxedMode
```
boolean isRelaxedMode()
```
    Return true if the query is in relaxed mapping mode.
  - getLabel
```
String getLabel()
```
    Return the label for the query.
    
    Specified by:
    
    getLabel in interface SpiSqlBinding
  - getPlanLabel
```
String getPlanLabel()
```
    Return the label with fallback to profile location label.
  - obtainLocation
```
void obtainLocation()
```
    Obtain the location if necessary.
  - getProfileLocation
```
ProfileLocation getProfileLocation()
```
    Return the profile location.
  - getType
```
Class<T> getType()
```
    Return the associated DTO bean type.
  - getOrmQuery
```
SpiQuery<?> getOrmQuery()
```
    Return an underlying ORM query (if this query is built from an ORM query).
  - getTransaction
```
Transaction getTransaction()
```
    Return the explicit transaction used to execute the query.