oracle.javatools.db
Class PlSqlMethod

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractChildDBObject
          oracle.javatools.db.PlSqlMethod

All Implemented Interfaces:

ChildDBObject, DBObject, DeclarativePlSql, Copyable, DynamicPropertySet

public class PlSqlMethod
extends AbstractChildDBObject
implements DeclarativePlSql

Model of a method in a PL/SQL object. For example a Type or Package can contain methods.

Nested Class Summary

static class	PlSqlMethod.CallSpecLanguage
static class	PlSqlMethod.MethodType

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

AbstractDBObject.ChildSupport

Field Summary

static java.lang.String

TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

PlSqlMethod()
Constructs a new object type method.

PlSqlMethod(java.lang.String name)
Constructs a new object type method with the specified name.

Method Summary

void	addParameter(int index, PlSqlParameter param) Adds one parameter to this Pl/SQL subprogram at the given index.
void	addParameter(PlSqlParameter p) Adds one parameter to this PlSql subprogram.
protected void	copyToImpl(AbstractDBObject other, DBObject copyParent, IDPolicy idPolicy) Implementation method for making a copy of this object.
protected boolean	equalsImpl(AbstractDBObject other) Equals implementation for testing equality with another AbstractDBObject.
java.lang.String	getBody() Deprecated.
PlSqlMethod.CallSpecLanguage	getCallSpecLanguage()
java.lang.String	getCallSpecLibName()
java.lang.String	getCallSpecName()
PlSqlMethod.MethodType	getMethodType()
PlSqlParameter	getParameter(java.lang.String name) Retrieves one parameter by name.
PlSqlParameter[]	getParameters() Retrieves the list of parameters going into the PlSql subprogram
DataType	getReturnType() Deprecated. - use getReturnTypeID()
DBObjectID	getReturnTypeID()
java.lang.String	getSignature()
SpecPlSql	getSpecPlSql() Gets the ComplexType that owns this method.
java.lang.String	getSqljSigName()
java.lang.String	getSqljSigVarName()
java.lang.String	getType() Returns the type of this object.
boolean	isCallSpecWithContext()
boolean	isFinal()
boolean	isInstantiable()
boolean	isOverriding()
void	removeParameter(PlSqlParameter param) Removes a parameter from this Pl/Sql subprogram.
void	setBody(java.lang.String body) Deprecated.
void	setCallSpecLanguage(PlSqlMethod.CallSpecLanguage callSpecLanguage)
void	setCallSpecLibName(java.lang.String callSpecLibName)
void	setCallSpecName(java.lang.String callSpecName)
void	setCallSpecWithContext(boolean callSpecWithContext)
void	setFinal(boolean isfinal)
void	setInstantiable(boolean instantiable)
void	setMethodType(PlSqlMethod.MethodType methodType)
void	setOverriding(boolean overriding)
void	setParameters(PlSqlParameter[] newParams) Sets the entire list of parameters, replacing any that have previously been added.
void	setReturnType(DataType returnType) Deprecated. - use setReturnTypeID()
void	setReturnTypeID(DBObjectID returnTypeID)
void	setSpecPlSql(SpecPlSql object) Sets the ComplexType that owns this method.
void	setSqljSigName(java.lang.String sqljSigName)
void	setSqljSigVarName(java.lang.String sqljSigVarName)

Methods inherited from class oracle.javatools.db.AbstractChildDBObject

findParent, getParent, getProperty, setParent, 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, getOwnedObjectsImpl, getProperties, getProperty, getReferenceIDs, getReferenceIDsImpl, 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, 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

PlSqlMethod

public PlSqlMethod()

Constructs a new object type method.

PlSqlMethod

public PlSqlMethod(java.lang.String name)

Constructs a new object type method with the specified name.

Parameters:

name - a string containing the method name

Method Detail

copyToImpl

protected void copyToImpl(AbstractDBObject other,
                          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 AbstractChildDBObject

Parameters:

other - 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 other)

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 AbstractDBObject

setMethodType

public void setMethodType(PlSqlMethod.MethodType methodType)

getMethodType

public PlSqlMethod.MethodType getMethodType()

setFinal

public void setFinal(boolean isfinal)

isFinal

public boolean isFinal()

setOverriding

public void setOverriding(boolean overriding)

isOverriding

public boolean isOverriding()

setInstantiable

public void setInstantiable(boolean instantiable)

isInstantiable

public boolean isInstantiable()

setCallSpecLanguage

public void setCallSpecLanguage(PlSqlMethod.CallSpecLanguage callSpecLanguage)

getCallSpecLanguage

public PlSqlMethod.CallSpecLanguage getCallSpecLanguage()

setCallSpecName

public void setCallSpecName(java.lang.String callSpecName)

getCallSpecName

public java.lang.String getCallSpecName()

setCallSpecLibName

public void setCallSpecLibName(java.lang.String callSpecLibName)

getCallSpecLibName

public java.lang.String getCallSpecLibName()

setCallSpecWithContext

public void setCallSpecWithContext(boolean callSpecWithContext)

isCallSpecWithContext

public boolean isCallSpecWithContext()

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

getSpecPlSql

public SpecPlSql getSpecPlSql()

Gets the ComplexType that owns this method.

Returns:

the object type that owns this method

setSpecPlSql

public void setSpecPlSql(SpecPlSql object)

Sets the ComplexType that owns this method.

Parameters:

relation - the object type that owns this method.

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

Returns:

a string describing the type of object.

setSqljSigName

public void setSqljSigName(java.lang.String sqljSigName)

getSqljSigName

public java.lang.String getSqljSigName()

setSqljSigVarName

public void setSqljSigVarName(java.lang.String sqljSigVarName)

getSqljSigVarName

public java.lang.String getSqljSigVarName()