org.jooq.meta

Interface RoutineDefinition

All Superinterfaces:

Definition

All Known Implementing Classes:

AbstractRoutineDefinition, FirebirdRoutineDefinition, H2RoutineDefinition, HSQLDBRoutineDefinition, MySQLRoutineDefinition, PostgresRoutineDefinition, XMLRoutineDefinition

public interface RoutineDefinition
extends Definition

An interface defining a stored routine in a database.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method and Description
List<ParameterDefinition>	getAllParameters() A list of all IN, OUT, and INOUT parameter column definitions
List<ParameterDefinition>	getInParameters() A list of IN or INOUT parameter column definitions
List<ParameterDefinition>	getOutParameters() A list of OUT or INOUT parameter column definitions
PackageDefinition	getPackage()
DataTypeDefinition	getReturnType()
DataTypeDefinition	getReturnType(JavaTypeResolver resolver)
ParameterDefinition	getReturnValue()
boolean	isAggregate()
boolean	isSQLUsable()

Methods inherited from interface org.jooq.meta.Definition

getCatalog, getComment, getDatabase, getDefinitionPath, getInputName, getName, getOutputName, getOverload, getQualifiedInputName, getQualifiedInputNamePart, getQualifiedName, getQualifiedNamePart, getQualifiedOutputName, getQualifiedOutputNamePart, getSchema, getSource

Method Detail

getPackage

PackageDefinition getPackage()

Specified by:

getPackage in interface Definition

Returns:

The routine's package. null if the routine is not in a package

getInParameters

List<ParameterDefinition> getInParameters()

A list of IN or INOUT parameter column definitions

getOutParameters

List<ParameterDefinition> getOutParameters()

A list of OUT or INOUT parameter column definitions

getAllParameters

List<ParameterDefinition> getAllParameters()

A list of all IN, OUT, and INOUT parameter column definitions

getReturnValue

ParameterDefinition getReturnValue()

Returns:

The return value column definition

getReturnType

DataTypeDefinition getReturnType()

Returns:

The return value simple Java type

getReturnType

DataTypeDefinition getReturnType(JavaTypeResolver resolver)

Returns:

The return value simple Java type

isSQLUsable

boolean isSQLUsable()

Returns:

Whether this routine can be used in SQL (a function without OUT parameters)

isAggregate

boolean isAggregate()

Returns:

Whether this routine is an aggregate function