TypedQuery (Jakarta EE 8 Specification API)

型パラメーター:
X - クエリ結果型
すべてのスーパーインターフェース:
Query
```
public interface TypedQuery<X>
extends Query
```
型付きクエリの実行を制御するために使用されるインターフェース。
導入:
2.0
関連事項:
Query, Parameter

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッドデフォルトメソッド
修飾子と型	メソッドと説明
`ListSE<X>`	`getResultList()` SELECT クエリを実行し、クエリ結果を型付きリストとして返します。
`default StreamSE<X>`	`getResultStream()` SELECT クエリを実行し、クエリ結果を型付き `java.util.stream.Stream` として返します。
`X`	`getSingleResult()` 単一の結果を返す SELECT クエリを実行します。
`TypedQuery<X>`	`setFirstResult(int startPosition)` 取得する最初の結果の位置を設定します。
`TypedQuery<X>`	`setFlushMode(FlushModeType flushMode)` クエリの実行に使用されるフラッシュモードの種類を設定します。
`TypedQuery<X>`	`setHint(StringSE hintName, ObjectSE value)` クエリのプロパティまたはヒントを設定します。
`TypedQuery<X>`	`setLockMode(LockModeType lockMode)` クエリの実行に使用するロックモード型を設定します。
`TypedQuery<X>`	`setMaxResults(int maxResult)` 取得する結果の最大数を設定します。
`TypedQuery<X>`	`setParameter(int position, CalendarSE value, TemporalType temporalType)` `java.util.Calendar` のインスタンスを定位置パラメーターにバインドします。
`TypedQuery<X>`	`setParameter(int position, DateSE value, TemporalType temporalType)` `java.util.Date` のインスタンスを定位置パラメーターにバインドします。
`TypedQuery<X>`	`setParameter(int position, ObjectSE value)` 引数値を定位置パラメーターにバインドします。
`TypedQuery<X>`	`setParameter(Parameter<CalendarSE> param, CalendarSE value, TemporalType temporalType)` `java.util.Calendar` のインスタンスを `Parameter` オブジェクトにバインドします。
`TypedQuery<X>`	`setParameter(Parameter<DateSE> param, DateSE value, TemporalType temporalType)` `java.util.Date` のインスタンスを `Parameter` オブジェクトにバインドします。
`<T> TypedQuery<X>`	`setParameter(Parameter<T> param, T value)` `Parameter` オブジェクトの値をバインドします。
`TypedQuery<X>`	`setParameter(StringSE name, CalendarSE value, TemporalType temporalType)` `java.util.Calendar` のインスタンスを名前付きパラメーターにバインドします。
`TypedQuery<X>`	`setParameter(StringSE name, DateSE value, TemporalType temporalType)` `java.util.Date` のインスタンスを名前付きパラメーターにバインドします。
`TypedQuery<X>`	`setParameter(StringSE name, ObjectSE value)` 引数値を名前付きパラメーターにバインドします。

インターフェース javax.persistence.Query から継承されたメソッド
executeUpdate, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

- メソッドの詳細
  - getResultList
```
ListSE<X> getResultList()
```
    SELECT クエリを実行し、クエリ結果を型付きリストとして返します。
    次で指定:
    インターフェース Query の getResultList
    戻り値:
    結果のリスト
    例外:
    IllegalStateExceptionSE - Java Persistence クエリ言語 UPDATE または DELETE ステートメントに対して呼び出された場合
    QueryTimeoutException - クエリ実行が設定されたクエリタイムアウト値を超え、ステートメントのみがロールバックされる場合
    TransactionRequiredException - NONE 以外のロックモードが設定されていて、トランザクションがない場合、または永続コンテキストがトランザクションに参加していない場合
    PessimisticLockException - 悲観的ロックが失敗し、トランザクションがロールバックされた場合
    LockTimeoutException - 悲観的ロックが失敗し、ステートメントのみがロールバックされる場合
    PersistenceException - クエリ実行が設定されたクエリタイムアウト値を超え、トランザクションがロールバックされた場合
  - getResultStream
```
default StreamSE<X> getResultStream()
```
    SELECT クエリを実行し、クエリ結果を型付き java.util.stream.Stream として返します。デフォルトでは、このメソッドは getResultList().stream() に委譲しますが、永続性プロバイダーはこのメソッドをオーバーライドして追加機能を提供することを選択できます。
    次で指定:
    インターフェース Query の getResultStream
    戻り値:
    結果のストリーム
    例外:
    IllegalStateExceptionSE - Java Persistence クエリ言語 UPDATE または DELETE ステートメントに対して呼び出された場合
    QueryTimeoutException - クエリ実行が設定されたクエリタイムアウト値を超え、ステートメントのみがロールバックされる場合
    TransactionRequiredException - NONE 以外のロックモードが設定されていて、トランザクションがない場合、または永続コンテキストがトランザクションに参加していない場合
    PessimisticLockException - 悲観的ロックが失敗し、トランザクションがロールバックされた場合
    LockTimeoutException - 悲観的ロックが失敗し、ステートメントのみがロールバックされる場合
    PersistenceException - クエリ実行が設定されたクエリタイムアウト値を超え、トランザクションがロールバックされた場合
    導入:
    2.2
    関連事項:
    StreamSE, getResultList()
  - getSingleResult
```
X getSingleResult()
```
    単一の結果を返す SELECT クエリを実行します。
    次で指定:
    インターフェース Query の getSingleResult
    戻り値:
    結果
    例外:
    NoResultException - 結果がない場合
    NonUniqueResultException - 複数の結果の場合
    IllegalStateExceptionSE - Java Persistence クエリ言語 UPDATE または DELETE ステートメントに対して呼び出された場合
    QueryTimeoutException - クエリ実行が設定されたクエリタイムアウト値を超え、ステートメントのみがロールバックされる場合
    TransactionRequiredException - NONE 以外のロックモードが設定されていて、トランザクションがない場合、または永続コンテキストがトランザクションに参加していない場合
    PessimisticLockException - 悲観的ロックが失敗し、トランザクションがロールバックされた場合
    LockTimeoutException - 悲観的ロックが失敗し、ステートメントのみがロールバックされる場合
    PersistenceException - クエリ実行が設定されたクエリタイムアウト値を超え、トランザクションがロールバックされた場合
  - setMaxResults
```
TypedQuery<X> setMaxResults(int maxResult)
```
    取得する結果の最大数を設定します。
    次で指定:
    インターフェース Query の setMaxResults
    パラメーター:
    maxResult - 取得する結果の最大数
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - 引数が負の場合
  - setFirstResult
```
TypedQuery<X> setFirstResult(int startPosition)
```
    取得する最初の結果の位置を設定します。
    次で指定:
    インターフェース Query の setFirstResult
    パラメーター:
    startPosition - 0 から番号付けされた最初の結果の位置
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - 引数が負の場合
  - setHint
```
TypedQuery<X> setHint(StringSE hintName,
                      ObjectSE value)
```
    クエリのプロパティまたはヒントを設定します。ヒント要素を使用して、クエリのプロパティとヒントを指定できます。この仕様で定義されているプロパティは、プロバイダーが遵守する必要があります。プロバイダーによって認識されないベンダー固有のヒントは、確認なしで無視する必要があります。ポータブルアプリケーションは、標準のタイムアウトヒントに依存しないでください。使用中のデータベースとプロバイダーが使用するロックメカニズムに応じて、このヒントは観測される場合とされない場合があります。
    次で指定:
    インターフェース Query の setHint
    パラメーター:
    hintName - プロパティまたはヒントの名前
    value - プロパティまたはヒントの値
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - 2 番目の引数が実装に有効でない場合
  - setParameter
```
<T> TypedQuery<X> setParameter(Parameter<T> param,
                               T value)
```
    Parameter オブジェクトの値をバインドします。
    次で指定:
    インターフェース Query の setParameter
    パラメーター:
    param - パラメーターオブジェクト
    value - パラメーター値
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - パラメーターがクエリのパラメーターに対応していない場合
  - setParameter
```
TypedQuery<X> setParameter(Parameter<CalendarSE> param,
                           CalendarSE value,
                           TemporalType temporalType)
```
    java.util.Calendar のインスタンスを Parameter オブジェクトにバインドします。
    次で指定:
    インターフェース Query の setParameter
    パラメーター:
    param - パラメーターオブジェクト
    value - パラメーター値
    temporalType - 時間型
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - パラメーターがクエリのパラメーターに対応していない場合
  - setParameter
```
TypedQuery<X> setParameter(Parameter<DateSE> param,
                           DateSE value,
                           TemporalType temporalType)
```
    java.util.Date のインスタンスを Parameter オブジェクトにバインドします。
    次で指定:
    インターフェース Query の setParameter
    パラメーター:
    param - パラメーターオブジェクト
    value - パラメーター値
    temporalType - 時間型
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - パラメーターがクエリのパラメーターに対応していない場合
  - setParameter
```
TypedQuery<X> setParameter(StringSE name,
                           ObjectSE value)
```
    引数値を名前付きパラメーターにバインドします。
    次で指定:
    インターフェース Query の setParameter
    パラメーター:
    name - パラメーター名
    value - パラメーター値
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - パラメーター名がクエリのパラメーターに対応していない場合、または引数の型が正しくない場合
  - setParameter
```
TypedQuery<X> setParameter(StringSE name,
                           CalendarSE value,
                           TemporalType temporalType)
```
    java.util.Calendar のインスタンスを名前付きパラメーターにバインドします。
    次で指定:
    インターフェース Query の setParameter
    パラメーター:
    name - パラメーター名
    value - パラメーター値
    temporalType - 時間型
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - パラメーター名がクエリのパラメーターに対応していない場合、または値の引数の型が正しくない場合
  - setParameter
```
TypedQuery<X> setParameter(StringSE name,
                           DateSE value,
                           TemporalType temporalType)
```
    java.util.Date のインスタンスを名前付きパラメーターにバインドします。
    次で指定:
    インターフェース Query の setParameter
    パラメーター:
    name - パラメーター名
    value - パラメーター値
    temporalType - 時間型
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - パラメーター名がクエリのパラメーターに対応していない場合、または値の引数の型が正しくない場合
  - setParameter
```
TypedQuery<X> setParameter(int position,
                           ObjectSE value)
```
    引数値を定位置パラメーターにバインドします。
    次で指定:
    インターフェース Query の setParameter
    パラメーター:
    position - 位置
    value - パラメーター値
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - 位置がクエリの位置パラメーターに対応していない場合、または引数の型が正しくない場合
  - setParameter
```
TypedQuery<X> setParameter(int position,
                           CalendarSE value,
                           TemporalType temporalType)
```
    java.util.Calendar のインスタンスを定位置パラメーターにバインドします。
    次で指定:
    インターフェース Query の setParameter
    パラメーター:
    position - 位置
    value - パラメーター値
    temporalType - 時間型
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - 位置がクエリの位置パラメーターに対応していない場合、または値の引数の型が正しくない場合
  - setParameter
```
TypedQuery<X> setParameter(int position,
                           DateSE value,
                           TemporalType temporalType)
```
    java.util.Date のインスタンスを定位置パラメーターにバインドします。
    次で指定:
    インターフェース Query の setParameter
    パラメーター:
    position - 位置
    value - パラメーター値
    temporalType - 時間型
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalArgumentExceptionSE - 位置がクエリの位置パラメーターに対応していない場合、または値の引数の型が正しくない場合
  - setFlushMode
```
TypedQuery<X> setFlushMode(FlushModeType flushMode)
```
    クエリの実行に使用するフラッシュモード型を設定します。フラッシュモード型は、エンティティマネージャーで使用されているフラッシュモード型に関係なく、クエリに適用されます。
    次で指定:
    インターフェース Query の setFlushMode
    パラメーター:
    flushMode - フラッシュモード
    戻り値:
    同じクエリインスタンス
  - setLockMode
```
TypedQuery<X> setLockMode(LockModeType lockMode)
```
    クエリの実行に使用するロックモード型を設定します。
    次で指定:
    インターフェース Query の setLockMode
    パラメーター:
    lockMode - ロックモード
    戻り値:
    同じクエリインスタンス
    例外:
    IllegalStateExceptionSE - クエリが Jakarta Persistence クエリ言語 SELECT クエリまたは CriteriaQuery クエリでないことが判明した場合

インターフェース TypedQuery<X>

メソッドのサマリー

インターフェース javax.persistence.Query から継承されたメソッド

メソッドの詳細

getResultList

getResultStream

getSingleResult

setMaxResults

setFirstResult

setHint

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setFlushMode

setLockMode