oracle.javatools.db.plsql

Class PlSqlSubProgram

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.plsql.DBObjectPlSqlFragment

oracle.javatools.db.plsql.PlSqlCodeFragment

oracle.javatools.db.plsql.PlSqlStatement

oracle.javatools.db.plsql.PlSqlBlock

oracle.javatools.db.plsql.PlSqlSubProgram

All Implemented Interfaces:

ChildDBObject, DBObject, SQLCallable, Copyable

Direct Known Subclasses:

PlSqlMethod, Procedure

public class PlSqlSubProgram
extends PlSqlBlock
implements SQLCallable

A representation of a PL/SQL procedure or function. Schema level procedures and functions are implemented by the subclasses Procedure and Function respectively and type methods by the subclass PlSqlMethod. However, procedures and functions in a package are implemented by this class directly.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.plsql.PlSqlStatement

PlSqlStatement.Type

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Constructors

Constructor and Description
PlSqlSubProgram()
PlSqlSubProgram(java.lang.String name, DBObject parent)

Method Summary

Modifier and Type	Method and Description
void	addParameter(int index, PlSqlParameter parameter) Adds the given PlSqlParameter to the Parameters property array at the specifed index
void	addParameter(PlSqlParameter parameter) Adds the given PlSqlParameter to the Parameters property array
java.lang.Integer	getArgumentDefiningReturnType()
SQLCallableArgument[]	getArguments()
java.lang.String	getDeclarartion() Deprecated. - Use getSignature()
PlSqlParameter	getParameter(java.lang.String name) Gets a Parameter of the given name
PlSqlParameter[]	getParameters() Get method for the Parameters property
DBObjectID	getReturnTypeID() Helper method to return the ID of the return type
PlSqlReference	getReturnTypeReference() Get method for the ReturnTypeReference property
java.lang.String	getSignature() Returns a String representation of the signature of the PlSqlSubProgram.
java.lang.String	getSignature(boolean names) Returns a String representation of the signature of the PlSqlSubProgram.
java.lang.String	getSignature(boolean showParent, boolean names) Returns a String representation of the signature of the PlSqlSubProgram.
java.lang.String	getType() Returns the type of this object.
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()
void	removeParameter(PlSqlParameter parameter) Removes the given PlSqlParameter from the Parameters property array
void	setParameters(PlSqlParameter[] parameters) Set method for the Parameters property
void	setReturnTypeReference(PlSqlReference returnTypeRef) Set method for the ReturnTypeReference property

Methods inherited from class oracle.javatools.db.plsql.PlSqlBlock

addBlock, addDatatype, addSubProgram, addVariable, findOwnedObject, getBlocks, getDatatypes, getSubProgram, getSubPrograms, getVariable, getVariables, setBlocks, setDatatypes, setSubPrograms, setVariables

Methods inherited from class oracle.javatools.db.plsql.PlSqlStatement

addStatement, getStatements, getStatementType, setStatements, setStatementType

Methods inherited from class oracle.javatools.db.plsql.PlSqlCodeFragment

addComment, addPropertyReference, addReference, getComments, getPropertyReferences, getReferences, setComments, setPropertyReferences, setReferences

Methods inherited from class oracle.javatools.db.plsql.DBObjectPlSqlFragment

copyToImpl, getChildAtOffset, getDeclarationAtOffset, getEndOffset, getName, getReferenceAtOffset, getSource, getSourceID, getStartOffset, setEndOffset, setSource, setSourceImpl, setStartOffset

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization, processPropertyChange, setID

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getChildSupport, getID, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, setName, setProperties, setProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.javatools.db.sql.SQLCallable

getName

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, getID, getOwnedObjects, getOwnedObjects, getProperties, getProperty, getProperty, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

PlSqlSubProgram

public PlSqlSubProgram()

PlSqlSubProgram

public PlSqlSubProgram(java.lang.String name,
                       DBObject parent)

Method Detail

getType

public java.lang.String getType()

Description copied from interface: DBObject

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Specified by:

getType in interface DBObject

Overrides:

getType in class PlSqlBlock

Returns:

a string describing the type of object.

setParameters

public void setParameters(PlSqlParameter[] parameters)

Set method for the Parameters property

Parameters:

parameters - the parameters (arguments) to this sub-program

Since:

11.1.2.0.0

getParameters

public PlSqlParameter[] getParameters()

Get method for the Parameters property

Returns:

the parameters (arguments) to this sub-program

Since:

11.1.2.0.0

addParameter

public void addParameter(PlSqlParameter parameter)

Adds the given PlSqlParameter to the Parameters property array

Parameters:

parameter -

Since:

11.1.2.0.0

addParameter

public void addParameter(int index,
                         PlSqlParameter parameter)

Adds the given PlSqlParameter to the Parameters property array at the specifed index

Parameters:

index - the index to add the new column at

parameter - the new parameter to add

removeParameter

public void removeParameter(PlSqlParameter parameter)

Removes the given PlSqlParameter from the Parameters property array

Parameters:

parameter -

Since:

12.1.1.0.0

getParameter

public PlSqlParameter getParameter(java.lang.String name)

Gets a Parameter of the given name

Returns:

Since:

11.1.2.0.0

getReturnTypeReference

public PlSqlReference getReturnTypeReference()

Get method for the ReturnTypeReference property

Returns:

a PlSqlReference to the data type of the return type. Null if this is a procedure.

Since:

11.1.2.0.0

setReturnTypeReference

public void setReturnTypeReference(PlSqlReference returnTypeRef)

Set method for the ReturnTypeReference property

Parameters:

returnTypeRef - a PlSqlReference to the data type of the return type

Since:

11.1.2.0.0

getReturnTypeID

public DBObjectID getReturnTypeID()

Helper method to return the ID of the return type

Specified by:

getReturnTypeID in interface SQLCallable

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 SQLCallable.getArgumentDefiningReturnType()) or if the method is not a function.

Since:

11.1.2.0.0

getSignature

public java.lang.String getSignature()

Returns a String representation of the signature of the PlSqlSubProgram. The name of the package for packages subprograms or type for type methods is not included. Both names and data types of parameters are shown

Returns:

signature of the PlSqlSubProgram

getSignature

public java.lang.String getSignature(boolean names)

Returns a String representation of the signature of the PlSqlSubProgram. The name of the package for packages subprograms or type for type methods is not included.

Parameters:

names - whether to show the names of the parameters (or just datatype)

Returns:

signature of the PlSqlSubProgram

getSignature

public java.lang.String getSignature(boolean showParent,
                                     boolean names)

Returns a String representation of the signature of the PlSqlSubProgram.

Parameters:

showParent - whether to include the name of the package for packages subprograms or type for type methods.

names - whetherto show the names of the parameters (or just datatype)

Returns:

signature of the PlSqlSubProgram

isFunction

public final boolean isFunction()

Specified by:

isFunction in interface SQLCallable

Returns:

True if the method returns a value

getArgumentDefiningReturnType

public final java.lang.Integer getArgumentDefiningReturnType()

Specified by:

getArgumentDefiningReturnType in interface SQLCallable

Returns:

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

getArguments

public final SQLCallableArgument[] getArguments()

Specified by:

getArguments in interface SQLCallable

Returns:

The arguments to the method

isAggregate

public final boolean isAggregate()

Specified by:

isAggregate in interface SQLCallable

Returns:

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

isWindow

public final boolean isWindow()

Specified by:

isWindow in interface SQLCallable

Returns:

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

isParenthesesRequired

public final boolean isParenthesesRequired()

Description copied from interface: SQLCallable

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.

Specified by:

isParenthesesRequired in interface SQLCallable

Returns:

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

isVariableArgumentList

public boolean isVariableArgumentList()

Specified by:

isVariableArgumentList in interface SQLCallable

Returns:

True if the method can take a variable number of arguments

getDeclarartion

@Deprecated
public final java.lang.String getDeclarartion()

Deprecated. - Use getSignature()