com.github.marschall.storedprocedureproxy.annotations

Annotation Type ReturnValue

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface ReturnValue

Signals that the procedure uses a return value rather than an out parameter or result set.

Also allows to provide additional information about the return value.

You would use this for functions as opposed to procedures.

Causes a call string to be generated in the form of "{ ? = call function_name()}" instead of "{call function_name(?)}".

See Also:

OutParameter

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name Defines the name of the return value.
int	type Defines the SQL type of the return value.

Element Detail

type

public abstract int type

Defines the SQL type of the return value. If nothing is specified the default from TypeMapper is used.

Returns:

the return value SQL type, can be a vendor type

See Also:

Types

Default:

-2147483648

name

public abstract String name

Defines the name of the return value. Only used if the parameter registration is either ProcedureCallerFactory.ParameterRegistration.NAME_ONLY or ProcedureCallerFactory.ParameterRegistration.NAME_AND_TYPE.

Returns:

the name of the return value

Default:

""