oracle.javatools.db.plsql

Class Procedure

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.PlSqlBlock

oracle.javatools.db.plsql.PlSqlSubProgram

oracle.javatools.db.plsql.Procedure

All Implemented Interfaces:

ChildDBObject, DBObject, PlSqlSourceObject, SchemaObject, SourceObject, SQLCallable, SystemObject, Copyable, DynamicPropertySet

Direct Known Subclasses:

Function

public class Procedure
extends PlSqlSubProgram
implements PlSqlSourceObject

Representation of a PL/SQL Procedure. NB This is a schema object, not a packaged procedure or method in a Type. Refer to PlSqlSubProgram and PlSqlMethod for those object types.

Nested Class Summary

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
Procedure()

Method Summary

Methods

Modifier and Type	Method and Description
PlSqlBlock[]	getBlocks() Get method for the Blocks property
PlSqlComment[]	getComments() Get method for the Comments property
PlSqlDatatype[]	getDatatypes() Get method for the Datatypes property
java.lang.Integer	getEndOffset() Get method for the EndOffset property
PlSqlParameter[]	getParameters() Get method for the Parameters property
PlSqlReference[]	getReferences() Get method for the References property
Schema	getSchema() Get method for the Schema property
java.lang.String	getSource() Get method for the Source property
java.lang.Integer	getStartOffset() Get method for the StartOffset property
PlSqlSubProgram[]	getSubPrograms() Get method for the SubPrograms property
java.lang.String	getType() Returns the type of this object.
PlSqlVariable[]	getVariables() Get method for the Variables property
void	setSchema(Schema schema) Set method for the Schema property
void	setSource(java.lang.String source) Set method for the Source property

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

addParameter, addParameter, getArgumentDefiningReturnType, getArguments, getDeclarartion, getParameter, getReturnTypeID, getReturnTypeReference, getSignature, getSignature, getSignature, isAggregate, isFunction, isParenthesesRequired, isVariableArgumentList, isWindow, removeParameter, setParameters, setReturnTypeReference

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

addBlock, addDatatype, addReference, addSubProgram, addVariable, findOwnedObject, getSubProgram, getVariable, setBlocks, setDatatypes, setReferences, setSubPrograms, setVariables

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

addComment, setComments

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

copyToImpl, getChildAtOffset, getDeclarationAtOffset, getEndToken, getName, getReferenceAtOffset, getSourceID, getStartToken, setEndOffset, 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

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, getID, getOwnedObjects, getOwnedObjects, getParent, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, removeThisAsParent, replaceReferenceIDs, setID, 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.plsql.PlSqlSourceObject

getChildAtOffset, getDeclarationAtOffset, getEndToken, getReferenceAtOffset, getStartToken

Methods inherited from interface oracle.javatools.db.SchemaObject

addObjectListener, removeObjectListener

Methods inherited from interface oracle.javatools.db.SystemObject

addObjectListener, fireObjectUpdated, removeObjectListener

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getParent, getProperties, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

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

getName

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

Procedure

public Procedure()

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 PlSqlSubProgram

Returns:

a string describing the type of object.

getSource

public java.lang.String getSource()

Get method for the Source property

Specified by:

getSource in interface PlSqlSourceObject

Specified by:

getSource in interface SourceObject

Returns:

the source representing this object

Since:

11.1.2.0.0

setSource

public void setSource(java.lang.String source)

Set method for the Source property

Specified by:

setSource in interface SourceObject

Parameters:

source - the source representing this object

Since:

11.1.2.0.0

setSchema

public void setSchema(Schema schema)

Set method for the Schema property

Specified by:

setSchema in interface SchemaObject

Parameters:

schema -

Since:

11.1.2.0.0

getSchema

public Schema getSchema()

Get method for the Schema property

Specified by:

getSchema in interface SchemaObject

Returns:

the schema

Since:

11.1.2.0.0

getStartOffset

public java.lang.Integer getStartOffset()

Description copied from class: DBObjectPlSqlFragment

Get method for the StartOffset property

Specified by:

getStartOffset in interface PlSqlSourceObject

Overrides:

getStartOffset in class DBObjectPlSqlFragment

Returns:

the start offset of this DBObjectPlSqlFragment within the source of the parent PlSqlSourceObject.

getEndOffset

public java.lang.Integer getEndOffset()

Description copied from class: DBObjectPlSqlFragment

Get method for the EndOffset property

Specified by:

getEndOffset in interface PlSqlSourceObject

Overrides:

getEndOffset in class DBObjectPlSqlFragment

Returns:

the end offset of this DBObjectPlSqlFragment within the source of the parent PlSqlSourceObject.

getParameters

public PlSqlParameter[] getParameters()

Description copied from class: PlSqlSubProgram

Get method for the Parameters property

Overrides:

getParameters in class PlSqlSubProgram

Returns:

the parameters (arguments) to this sub-program

getComments

public PlSqlComment[] getComments()

Description copied from class: PlSqlCodeFragment

Get method for the Comments property

Specified by:

getComments in interface PlSqlSourceObject

Overrides:

getComments in class PlSqlCodeFragment

Returns:

comments within this PlSql code fragment

getBlocks

public PlSqlBlock[] getBlocks()

Description copied from class: PlSqlBlock

Get method for the Blocks property

Specified by:

getBlocks in interface PlSqlSourceObject

Overrides:

getBlocks in class PlSqlBlock

Returns:

any child PlSqlBlock's

getReferences

public PlSqlReference[] getReferences()

Description copied from class: PlSqlBlock

Get method for the References property

Specified by:

getReferences in interface PlSqlSourceObject

Overrides:

getReferences in class PlSqlBlock

Returns:

references to other objects from within this PlSqlBlock

getVariables

public PlSqlVariable[] getVariables()

Description copied from class: PlSqlBlock

Get method for the Variables property

Specified by:

getVariables in interface PlSqlSourceObject

Overrides:

getVariables in class PlSqlBlock

Returns:

Variables defined within this PlSqlBlock

getSubPrograms

public PlSqlSubProgram[] getSubPrograms()

Description copied from class: PlSqlBlock

Get method for the SubPrograms property

Specified by:

getSubPrograms in interface PlSqlSourceObject

Overrides:

getSubPrograms in class PlSqlBlock

Returns:

SubPrograms (procedures and functions) defined within this PlSqlBlock

getDatatypes

public PlSqlDatatype[] getDatatypes()

Description copied from class: PlSqlBlock

Get method for the Datatypes property

Specified by:

getDatatypes in interface PlSqlSourceObject

Overrides:

getDatatypes in class PlSqlBlock

Returns:

DataTypes defined within this PlSqlBlock