Function (doma 2.0-beta-2 API)

```
@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface Function
```
ストアドファンクションの呼び出しを示します。
このアノテーションが注釈されるメソッドは、Daoインタフェースのメンバでなければいけません。
例:
```
 @Dao(config = AppConfig.class)
 public interface EmployeeDao {
 
     @Function
     BigDecimal getSalary(@In Integer id, @Out Reference<String> name);
 }
 
```
注釈されるメソッドは、次の例外をスローすることがあります。
- DomaNullPointerException パラメータに nullを渡した場合
- UnknownColumnException ResultSet を使用していて結果セットに含まれるカラムにマッピングされたプロパティが見つからなかった場合
- JdbcException JDBCに関する例外が発生した場合
関連項目:

In, InOut, Out, ResultSet

任意要素の概要

任意要素
修飾子とタイプ	任意要素と説明
`java.lang.String`	`catalog` カタログ名を返します。
`boolean`	`ensureResultMapping` 結果がエンティティやエンティティのリストの場合、エンティティのすべてのプロパティに結果セットのカラムがマッピングされることを保証するかどうかを返します。
`MapKeyNamingType`	`mapKeyNaming` 結果セットを `Map<Object, String>` もしくは `List<Map<Object, String>>` として取得する場合のマップのキーに対するネーミング規約を返します。
`java.lang.String`	`name` ストアドファンクションの名前を返します。
`int`	`queryTimeout` クエリタイムアウト（秒）を返します。
`boolean`	`quote` カタログ、スキーマ、ストアドファンクション名を引用符で囲むかどうかを返します。
`java.lang.String`	`schema` スキーマ名を返します。

- 要素の詳細
  - catalog
```
public abstract java.lang.String catalog
```
    カタログ名を返します。
    
    戻り値:
    
    カタログ名
    
    デフォルト:
    
    ""
- - schema
```
public abstract java.lang.String schema
```
    スキーマ名を返します。
    
    戻り値:
    
    スキーマ名
    
    デフォルト:
    
    ""
- - name
```
public abstract java.lang.String name
```
    ストアドファンクションの名前を返します。
    指定しない場合、注釈されたメソッドの名前が使用されます。
    
    戻り値:
    
    ストアドファンクションの名前
    
    デフォルト:
    
    ""
- - quote
```
public abstract boolean quote
```
    カタログ、スキーマ、ストアドファンクション名を引用符で囲むかどうかを返します。
    
    戻り値:
    
    引用符で囲むかどうか。
    
    デフォルト:
    
    false
- - queryTimeout
```
public abstract int queryTimeout
```
    クエリタイムアウト（秒）を返します。
    指定しない場合、Config.getQueryTimeout()が使用されます。
    
    戻り値:
    
    クエリタイムアウト（秒）
    
    関連項目:
    
    Statement.setQueryTimeout(int)
    
    デフォルト:
    
    -1
- - mapKeyNaming
```
public abstract MapKeyNamingType mapKeyNaming
```
    結果セットを Map<Object, String> もしくは List<Map<Object, String>> として取得する場合のマップのキーに対するネーミング規約を返します。
    
    戻り値:
    
    ネーミング規約
    
    導入されたバージョン:
    
    1.7.0
    
    デフォルト:
    
    org.seasar.doma.MapKeyNamingType.NONE
- - ensureResultMapping
```
public abstract boolean ensureResultMapping
```
    結果がエンティティやエンティティのリストの場合、エンティティのすべてのプロパティに結果セットのカラムがマッピングされることを保証するかどうかを返します。
    true の場合、マッピングされないプロパティが存在すれば、このアノテーションが注釈されたメソッドから ResultMappingException がスローされます。
    
    戻り値:
    
    マッピングされることを保証するかどうか
    
    導入されたバージョン:
    
    1.34.0
    
    デフォルト:
    
    false

注釈型 Function

例:

任意要素の概要

要素の詳細

catalog

schema

name

quote

queryTimeout

mapKeyNaming

ensureResultMapping