Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.0.0)

E17493-01

oracle.javatools.db.plsql
Class PlSqlSubProgram

java.lang.Object
  extended by oracle.javatools.db.AbstractDBObject
      extended by oracle.javatools.db.AbstractBuildableObject
          extended by oracle.javatools.db.plsql.DBObjectPlSqlFragment
              extended by oracle.javatools.db.plsql.PlSqlBlock
                  extended by oracle.javatools.db.plsql.PlSqlSubProgram
All Implemented Interfaces:
ChildDBObject, DBObject, Copyable, DynamicPropertySet
Direct Known Subclasses:
PlSqlMethod, Procedure

public class PlSqlSubProgram
extends PlSqlBlock

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.AbstractDBObject
AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport
 
Field Summary
static java.lang.String TYPE
           
 
Fields inherited from interface oracle.javatools.db.DBObject
COMMENT
 
Constructor Summary
PlSqlSubProgram()
           
PlSqlSubProgram(java.lang.String name, DBObject parent)
           
 
Method Summary
 void addParameter(PlSqlParameter parameter)
          Adds the given PlSqlParameter to the Parameters property array
 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()
          Get method for the Signature property
 java.lang.String getSignature(boolean names)
           
 java.lang.String getType()
          Returns the type of this object.
 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, addReference, addSubProgram, addVariable, getBlocks, getDatatypes, getReferences, getSubProgram, getSubPrograms, getVariable, getVariables, setBlocks, setDatatypes, setReferences, setSubPrograms, setVariables
 
Methods inherited from class oracle.javatools.db.plsql.DBObjectPlSqlFragment
clearSourceID, copyToImpl, getChildAtOffset, getEndOffset, getParent, getSourceID, getStartOffset, setEndOffset, setParent, setStartOffset
 
Methods inherited from class oracle.javatools.db.AbstractBuildableObject
checkInit, checkInit, equalsImpl, getOwnedObjectsImpl, getProperties, getProperty, getReferenceIDsImpl, needsInitialization, setProperty
 
Methods inherited from class oracle.javatools.db.AbstractDBObject
changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.javatools.db.DBObject
copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, replaceReferenceIDs, setID, setName
 
Methods inherited from interface oracle.javatools.util.DynamicPropertySet
getProperties, getProperty, getProperty, 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

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

Since:
11.1.2.0.0

getSignature

public java.lang.String getSignature()
Get method for the Signature property

Returns:
Since:
11.1.2.0.0

getSignature

public java.lang.String getSignature(boolean names)

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.0.0)

E17493-01

Copyright © 1997, 2011, Oracle. All rights reserved.