schemacrawler.schema

Interface Function

All Superinterfaces:

AttributedObject, Comparable<NamedObject>, DatabaseObject, DefinedObject, DescribedObject, NamedObject, Routine, Serializable, TypedObject<RoutineType>

public interface Function
extends Routine

Represents a database function.

Method Summary

Modifier and Type	Method and Description
List<FunctionParameter>	getParameters() Gets the list of columns in ordinal order.
FunctionReturnType	getReturnType() Gets the procedure type.
RoutineBodyType	getRoutineBodyType() Gets the type of the routine body.
Optional<? extends FunctionParameter>	lookupParameter(String name) Gets a column by name.

Methods inherited from interface schemacrawler.schema.Routine

getRoutineType, getSpecificName

Methods inherited from interface schemacrawler.schema.DatabaseObject

getSchema, withQuoting

Methods inherited from interface schemacrawler.schema.NamedObject

getFullName, getName, key

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface schemacrawler.schema.AttributedObject

getAttribute, getAttribute, getAttributes, hasAttribute, lookupAttribute, removeAttribute, setAttribute

Methods inherited from interface schemacrawler.schema.DescribedObject

getRemarks, hasRemarks, setRemarks

Methods inherited from interface schemacrawler.schema.TypedObject

getType

Methods inherited from interface schemacrawler.schema.DefinedObject

getDefinition, hasDefinition

Method Detail

getParameters

List<FunctionParameter> getParameters()

Gets the list of columns in ordinal order.

Specified by:

getParameters in interface Routine

Returns:

Columns of the procedure

getReturnType

FunctionReturnType getReturnType()

Gets the procedure type.

Specified by:

getReturnType in interface Routine

Returns:

Procedure type

getRoutineBodyType

RoutineBodyType getRoutineBodyType()

Gets the type of the routine body.

Specified by:

getRoutineBodyType in interface Routine

Returns:

Routine body type

lookupParameter

Optional<? extends FunctionParameter> lookupParameter(String name)

Gets a column by name.

Specified by:

lookupParameter in interface Routine

Parameters:

name - Name

Returns:

Column of the procedure