oracle.javatools.db.sql

Interface SQLCallable

All Known Implementing Classes:

BuiltInFunction, Function, PlSqlMethod, PlSqlSubProgram, Procedure

public interface SQLCallable

Defines a callable method from within SQL (or PL/SQL)

Since:

12.1.3

See Also:

SQLCallableArgument

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Integer	getArgumentDefiningReturnType()
SQLCallableArgument[]	getArguments()
java.lang.String	getName()
DBObjectID	getReturnTypeID()
boolean	isAggregate()
boolean	isFunction()
boolean	isParenthesesRequired() Typically a function with arguments will require parentheses and one with no arguments will not.
boolean	isVariableArgumentList()
boolean	isWindow()

Method Detail

getName

java.lang.String getName()

Returns:

The name of the callable method

isFunction

boolean isFunction()

Returns:

True if the method returns a value

isVariableArgumentList

boolean isVariableArgumentList()

Returns:

True if the method can take a variable number of arguments

getReturnTypeID

DBObjectID getReturnTypeID()

Returns:

The id of the method return type (or an approximation) if known. Can be null if the return type is not known, or is defined by one of the arguments (see getArgumentDefiningReturnType()) or if the method is not a function.

getArgumentDefiningReturnType

java.lang.Integer getArgumentDefiningReturnType()

Returns:

The argument number that specifies the return type, if any.

getArguments

SQLCallableArgument[] getArguments()

Returns:

The arguments to the method

isAggregate

boolean isAggregate()

Returns:

True if this is an aggregate (aka grouping) function. False otherwise.

isWindow

boolean isWindow()

Returns:

True if this is an window (aka analytic) function. False otherwise.

isParenthesesRequired

boolean isParenthesesRequired()

Typically a function with arguments will require parentheses and one with no arguments will not. This method indicates whether there is any deviation from that.

Returns:

True if a call to this function requires parentheses. False otherwise.