Module org.seasar.doma.core

Package org.seasar.doma

Annotation Interface Procedure

@Target(METHOD)
@Retention(RUNTIME)
public @interface Procedure

Indicates a stored procedure call.

The annotated method must be a member of a Dao annotated interface.

 @Dao
 public interface EmployeeDao {

     @Procedure
     void updateSalary(@In Integer id, @InOut Reference<BigDecimal> salary);
 }
 

The method may throw following exceptions:

• DomaNullPointerException if any of the method parameters are null
• UnknownColumnException if ResultSet is used and a column is not found in the result set
• JdbcException if a JDBC related error occurs

See Also:

• In
• InOut
• Out
• ResultSet

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	catalog
MapKeyNamingType	mapKeyNaming	The naming convention for keys of Map<Object, String>.
String	name	The stored procedure name.
int	queryTimeout	The query timeout in seconds.
boolean	quote
String	schema
SqlLogType	sqlLog

Element Details

catalog

String catalog

Returns:

the catalog name for the stored procedure.

Default:

""

schema

String schema

Returns:

the schema name for the stored procedure.

Default:

""

name

String name

The stored procedure name.

If not specified, the annotated method name is used.

Returns:

the stored procedure name

Default:

""

quote

boolean quote

Returns:

whether quotation marks should be used for the catalog name, the schema name and the stored procedure name in SQL statements.

Default:

false

queryTimeout

int queryTimeout

The query timeout in seconds.

If not specified, Config.getQueryTimeout() is used.

Returns:

the query timeout

See Also:

• Statement.setQueryTimeout(int)

Default:

-1

mapKeyNaming

MapKeyNamingType mapKeyNaming

The naming convention for keys of Map<Object, String>.

This value is used only if a result set is fetched as Map<Object, String> or List<Map<Object, String>>.

Returns:

the naming convention

Default:

NONE

sqlLog

SqlLogType sqlLog

Returns:

the output format to be used for SQL logs when this procedure is executed.

Default:

FORMATTED