Skip navigation links
oracle.javatools.db
Class PlSqlSubprogram
java.lang.Object
oracle.javatools.db.AbstractDBObject
oracle.javatools.db.AbstractBuildableObject
oracle.javatools.db.AbstractSystemObject
oracle.javatools.db.AbstractSchemaObject
oracle.javatools.db.PlSql
oracle.javatools.db.PlSqlSubprogram
- All Implemented Interfaces:
- DBObject, DeclarativePlSql, SchemaObject, SourceObject, SystemObject, Copyable, DynamicPropertySet
- Direct Known Subclasses:
- Function, Procedure
-
public abstract class PlSqlSubprogram
- extends PlSql
- implements DeclarativePlSql
Abstract implementation of PlSql for objects that are a simple subprogram (e.g. function or procedure).
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, getParent, getReferenceIDs, getType, replaceReferenceIDs, setID, setName |
PlSqlSubprogram
public PlSqlSubprogram()
PlSqlSubprogram
public PlSqlSubprogram(java.lang.String name,
Schema schema)
copyToImpl
protected void copyToImpl(AbstractDBObject copy,
DBObject copyParent,
IDPolicy idPolicy)
- Description copied from class:
AbstractDBObject
- Implementation method for making a copy of this object. To add custom copyTo logic, a subclass must override this method (exactly), and must call back to the super implementation.
-
- Overrides:
copyToImpl
in class PlSql
-
- Parameters:
copy
- the copy being created of this object
copyParent
- if this object is being copied underneath a parent, this parameter is the copy of the parent of this object, which will therefore need to be the parent of the copy of this object.
idPolicy
- the policy for copying the object's ID.
equalsImpl
protected boolean equalsImpl(AbstractDBObject target)
- Description copied from class:
AbstractDBObject
- Equals implementation for testing equality with another AbstractDBObject. Override this method (with exact signature) to customise the equality comparison.
-
- Overrides:
equalsImpl
in class PlSql
getReturnType
@Deprecated
public DataType getReturnType()
- Deprecated. - use getReturnTypeID()
setReturnType
@Deprecated
public void setReturnType(DataType returnType)
- Deprecated. - use setReturnTypeID()
getReturnTypeID
public DBObjectID getReturnTypeID()
-
- Specified by:
getReturnTypeID
in interface DeclarativePlSql
setReturnTypeID
public void setReturnTypeID(DBObjectID returnTypeID)
-
- Specified by:
setReturnTypeID
in interface DeclarativePlSql
setParameters
public void setParameters(PlSqlParameter[] newParams)
- Sets the entire list of parameters, replacing any that have previously been added.
-
- Specified by:
setParameters
in interface DeclarativePlSql
-
- Parameters:
newParams
- an array containing the new list of parameters
getParameters
public PlSqlParameter[] getParameters()
- Retrieves the list of parameters going into the PlSql subprogram
-
- Specified by:
getParameters
in interface DeclarativePlSql
-
- Returns:
- an array containing the list of parameters
addParameter
public void addParameter(PlSqlParameter p)
- Adds one parameter to this PlSql subprogram.
-
- Specified by:
addParameter
in interface DeclarativePlSql
-
- Parameters:
p
- the new parameter to add
addParameter
public void addParameter(int index,
PlSqlParameter param)
- Adds one parameter to this Pl/SQL subprogram at the given index. Shift the PlSqlParameter at that position (and any subesquent PlSqlParameters) down one place.
-
- Specified by:
addParameter
in interface DeclarativePlSql
-
- Parameters:
index
- the index to add the new parameter at
param
- the new parameter to add
getParameter
public PlSqlParameter getParameter(java.lang.String name)
- Retrieves one parameter by name.
-
- Specified by:
getParameter
in interface DeclarativePlSql
-
- Parameters:
a
- string containing the desired parameter
- Returns:
- The parameter requested or
null
removeParameter
public void removeParameter(PlSqlParameter param)
- Removes a parameter from this Pl/Sql subprogram.
-
- Specified by:
removeParameter
in interface DeclarativePlSql
-
- Parameters:
param
- the parameter to remove
getBody
@Deprecated
public java.lang.String getBody()
- Deprecated.
-
- Specified by:
getBody
in interface DeclarativePlSql
setBody
@Deprecated
public void setBody(java.lang.String body)
- Deprecated.
-
- Specified by:
setBody
in interface DeclarativePlSql
getSignature
public java.lang.String getSignature()
-
- Specified by:
getSignature
in interface DeclarativePlSql
getReferenceIDsImpl
protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)
- Description copied from class:
AbstractBuildableObject
- Implementation first checks that the object has been built - then returns the collection from suprt.getReferenceIDsImpl(). All overrides must call this first to ensure the object has been built.
-
- Overrides:
getReferenceIDsImpl
in class AbstractBuildableObject
-
- Parameters:
refs
- the collection of ids this object references
getOwnedObjectsImpl
protected void getOwnedObjectsImpl(java.util.Collection<DBObject> c,
java.lang.String[] types)
- Description copied from class:
AbstractBuildableObject
- Implementation first checks that the object has been built - then returns the collection from suprt.getOwnedObjectsImpl(). All overrides must call this first to ensure the object has been built.
-
- Overrides:
getOwnedObjectsImpl
in class AbstractBuildableObject
-
- Parameters:
c
- a Collection of the apppropriate children.
types
- a vararg of the type(s) to search for
- See Also:
AbstractDBObject.includesType(java.lang.String, java.lang.String...)
Skip navigation links
Copyright © 1997, 2013, Oracle. All rights reserved.