oracle.javatools.db
Class Function

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractSchemaObject
          oracle.javatools.db.PlSql
              oracle.javatools.db.PlSqlSubprogram
                  oracle.javatools.db.Function

All Implemented Interfaces:

DBObject, DeclarativePlSql, SchemaObject, SourceObject, Copyable, DynamicPropertySet

public class Function
extends PlSqlSubprogram

Model of a pl/sql function. As a declarative pl/sql implementation the parameters and return type can be set as individual properties.

Nested Class Summary

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

AbstractDBObject.ChildSupport

Field Summary

static java.lang.String

TYPE

Fields inherited from class oracle.javatools.db.PlSql

BLOCK_TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

Function()

Function(java.lang.String name, Schema schema)

Method Summary

DBObject	copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy) Internal copy method used by the API to perform copy operations.
protected void	copyToImpl(Function copy, DBObject copyParent, IDPolicy idPolicy)
boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(Function target)
java.lang.String	getType() Returns the type of this object.

Methods inherited from class oracle.javatools.db.PlSqlSubprogram

addParameter, addParameter, copyToImpl, equalsImpl, getBody, getParameter, getParameters, getReturnType, getReturnTypeID, getSignature, removeParameter, setBody, setParameters, setReturnType, setReturnTypeID

Methods inherited from class oracle.javatools.db.PlSql

copyToImpl, equalsImpl, getSource, getSourceInterrogator, isPlSql, setSource

Methods inherited from class oracle.javatools.db.AbstractSchemaObject

addObjectListener, checkInit, checkInit, checkInitEx, copyToImpl, equalsImpl, fireObjectUpdated, getOwnedObjectsImpl, getParent, getProperties, getProperty, getProperty, getReferenceIDsImpl, getSchema, needsInitialization, removeObjectListener, setProperties, setProperty, setSchema

Methods inherited from class oracle.javatools.db.AbstractDBObject

changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyToImpl, equalsImpl, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, 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, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

Methods inherited from interface oracle.javatools.db.SchemaObject

addObjectListener, fireObjectUpdated, getSchema, removeObjectListener, setSchema

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

Function

public Function()

Function

public Function(java.lang.String name,
                Schema schema)

Method Detail

copyTo

public DBObject copyTo(DBObject target,
                       DBObject copyParent,
                       IDPolicy idPolicy)

Description copied from class: AbstractDBObject

Internal copy method used by the API to perform copy operations. All objects must implement this method if they are instantiable objects. Abstract objects (e.g. Relation) must NOT implement this method. The implementation should delegate to the copyToImpl method to copy the actual properties.

This method does not fix internal reference ids on copy. That is done by the calling DBObject.copyTo(DBObject, IDPolicy) method.

Specified by:

copyTo in class AbstractDBObject

See Also:

DBObject.copyTo(java.lang.Object), DBObject.copyTo(DBObject, boolean), AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)

equals

public boolean equals(java.lang.Object target)

Overrides:

equals in class java.lang.Object

copyToImpl

protected void copyToImpl(Function copy,
                          DBObject copyParent,
                          IDPolicy idPolicy)

equalsImpl

protected boolean equalsImpl(Function target)

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.

Returns:

a string describing the type of object.