public class PlSqlSubProgram extends PlSqlBlock implements SQLCallable
Procedure
and Function
respectively and type methods
by the subclass PlSqlMethod
. However, procedures and functions
in a package are implemented by this class directly.AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TYPE |
Constructor and Description |
---|
PlSqlSubProgram() |
PlSqlSubProgram(java.lang.String name,
DBObject parent) |
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()
Returns the declaration of the PlSqlSubProgram directly from the source
retaining all comments, white space and formatting.
|
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
|
addBlock, addDatatype, addReference, addSubProgram, addVariable, findOwnedObject, getBlocks, getDatatypes, getReferences, getSubProgram, getSubPrograms, getVariable, getVariables, setBlocks, setDatatypes, setReferences, setSubPrograms, setVariables
addComment, getComments, setComments
copyToImpl, getChildAtOffset, getDeclarationAtOffset, getEndOffset, getEndToken, getName, getReferenceAtOffset, getSourceID, getStartOffset, getStartToken, setEndOffset, setSourceImpl, setStartOffset
setParent
checkInit, checkInit, getOwnedObjectsImpl, getProperties, getReferenceIDsImpl, needsInitialization
addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getID, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, setProperty, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getName
getParent
addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, getID, getOwnedObjects, getOwnedObjects, getProperties, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName
getProperty, getProperty, setProperties, setProperty
public static final java.lang.String TYPE
public PlSqlSubProgram()
public PlSqlSubProgram(java.lang.String name, DBObject parent)
public java.lang.String getType()
DBObject
getType
in interface DBObject
getType
in class PlSqlBlock
public void setParameters(PlSqlParameter[] parameters)
parameters
- the parameters (arguments) to this sub-programpublic PlSqlParameter[] getParameters()
public void addParameter(PlSqlParameter parameter)
parameter
- public void addParameter(int index, PlSqlParameter parameter)
index
- the index to add the new column atparameter
- the new parameter to addpublic void removeParameter(PlSqlParameter parameter)
parameter
- public PlSqlParameter getParameter(java.lang.String name)
public PlSqlReference getReturnTypeReference()
public void setReturnTypeReference(PlSqlReference returnTypeRef)
returnTypeRef
- a PlSqlReference to the data type of the return typepublic DBObjectID getReturnTypeID()
getReturnTypeID
in interface SQLCallable
SQLCallable.getArgumentDefiningReturnType()
) or if the method is not a function.public java.lang.String getSignature()
public java.lang.String getSignature(boolean names)
names
- whether to show the names of the parameters (or just datatype)public java.lang.String getSignature(boolean showParent, boolean names)
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)public final java.lang.String getDeclarartion()
public final boolean isFunction()
isFunction
in interface SQLCallable
public final java.lang.Integer getArgumentDefiningReturnType()
getArgumentDefiningReturnType
in interface SQLCallable
public final SQLCallableArgument[] getArguments()
getArguments
in interface SQLCallable
public final boolean isAggregate()
isAggregate
in interface SQLCallable
public final boolean isWindow()
isWindow
in interface SQLCallable
public final boolean isParenthesesRequired()
SQLCallable
isParenthesesRequired
in interface SQLCallable
public boolean isVariableArgumentList()
isVariableArgumentList
in interface SQLCallable