NamedStoredProcedureQuery (javax.persistence-api 2.2 API)

```
@Repeatable(value=NamedStoredProcedureQueries.class)
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface NamedStoredProcedureQuery
```
ストアドプロシージャとそのパラメーターと結果の型を指定し、名前を付けます。
NamedStoredProcedureQueryアノテーションはエンティティ(Entityの付いたクラス)やマップドスーパークラス(MappedSuperclassの付いたクラス)に適用できます。
name要素はEntityManager.createNamedStoredProcedureQuery(java.lang.String)メソッドに実行可能なStoredProcedureQueryオブジェクトを作成するときに引数として渡される名前です。名前は永続化ユニット内で共有されます。
procedureName要素はデータベース内でのストアドプロシージャの名前です。
ストアドプロシージャのパラメーターはparameters要素で指定します。すべてのパラメーターをストアドプロシージャのパラメーターリスト内に出現する順序で指定する必要があります。
resultClasses要素は結果をマッピングするために使用されるクラスを示します。 SqlResultSetMappingアノテーションで定義されているのと同じでresultSetMappings要素は1つ以上の結果セットのマッピングを指定します。
複数の結果セットがある場合、それらは同じメカニズムを使用してマッピングされると想定されます。たとえば、結果クラスマッピングのセットもしくは結果セットマッピングのセットのどちらかすべてを介してマッピングされます。これらのマッピングの指定の順序はストアドプロシージャの呼び出しによって結果セットが戻される順序と同じでなければなりません。ストアドプロシージャが1つ以上の結果セットを返し、resultClassesやresultSetMappings要素のいずれも指定されていない場合、結果セットはObjectの配列のリストとして返されます。ストアドプロシージャの結果セットのマッピングに異なる戦略を組み合わせる方法は定義されていません。
hints要素はクエリーのプロパティやヒントを指定するのに使用できます。この仕様(JPA Spec.)では定義されているプロパティはプロバイダによって監視されなければなりません。プロバイダによって認識されないベンダー固有のヒントは無視される必要があります。
名前付きストアドプロシージャクエリー内のすべてのパラメーターをStoredProcedureParameterを使用して指定する必要があります。

導入されたバージョン:

Java Persistence 2.1

関連項目:

StoredProcedureQuery, StoredProcedureParameter

必須要素のサマリー

必須要素
修飾子とタイプ	必須要素と説明
`java.lang.String`	`name` `EntityManager`のメソッドでストアドプロシージャのクエリーオブジェクトを作成するときの参照として使用される名前。
`java.lang.String`	`procedureName` データベース内のストアドプロシージャの名前。

任意要素のサマリー

任意要素
修飾子とタイプ	任意要素と説明
`QueryHint[]`	`hints` クエリーのプロパティとヒント。
`StoredProcedureParameter[]`	`parameters` ストアドプロシージャのすべてのパラメーターの情報。
`java.lang.Class[]`	`resultClasses` 結果のマッピングに使用されるクラス。
`java.lang.String[]`	`resultSetMappings` メタデータとして定義される一つ以上の結果セットのマッピングの名前。

- 要素の詳細
  - name
```
public abstract java.lang.String name
```
    EntityManagerのメソッドでストアドプロシージャのクエリーオブジェクトを作成するときの参照として使用される名前。
- - procedureName
```
public abstract java.lang.String procedureName
```
    データベース内のストアドプロシージャの名前。
- - parameters
```
public abstract StoredProcedureParameter[] parameters
```
    ストアドプロシージャのすべてのパラメーターの情報。すべてのパラメーターはストアドプロシージャのパラメーターリスト内に出現する順序で指定する必要があります。
    
    デフォルト:
    
    {}
- - resultClasses
```
public abstract java.lang.Class[] resultClasses
```
    結果のマッピングに使用されるクラス。
    
    デフォルト:
    
    {}
- - resultSetMappings
```
public abstract java.lang.String[] resultSetMappings
```
    メタデータとして定義される一つ以上の結果セットのマッピングの名前。
    
    デフォルト:
    
    {}
- - hints
```
public abstract QueryHint[] hints
```
    クエリーのプロパティとヒント。(ベンダー固有のクエリーのヒントが含まれます。)
    
    デフォルト:
    
    {}

注釈型 NamedStoredProcedureQuery

必須要素のサマリー

任意要素のサマリー

要素の詳細

name

procedureName

parameters

resultClasses

resultSetMappings

hints