Skip navigation links

oracle.javatools.db
Class PlSqlParameter

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

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

public class PlSqlParameter

extends AbstractChildDBObject

Model of a parameter to a PL/SQL subprogram like a function or the method of an object type.

Nested Class Summary

static class

PlSqlParameter.Mode

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

PlSqlParameter()
Constructs a new object type attribute.

PlSqlParameter(java.lang.String name)
Constructs a new object type attribute with the specified name.

PlSqlParameter(java.lang.String name, DataType dataType)
Constructs a new attribute with the specified name and datatype.

Method Summary

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.
DataType	getDataType() Deprecated. use getDataTypeID() instead
void	getDataType(DataType datatype) Deprecated. use setDataTypeID(oracle.javatools.db.DBObjectID) instead
DBObjectID	getDataTypeID()
java.lang.String	getDefaultValue()
PlSqlParameter.Mode	getMode()
DeclarativePlSql	getPlSql() Gets the PL/SQL routine that owns this parameter.
protected void	getReferenceIDsImpl(java.util.Collection<DBObjectID> refs) Used by the final getReferenceID() implementation.
java.lang.String	getType() Returns the type of this object.
boolean	isNoCopy()
void	setDataTypeID(DBObjectID dataTypeID)
void	setDefaultValue(java.lang.String def)
void	setMode(PlSqlParameter.Mode mode)
void	setNoCopy(boolean noCopy)
void	setPlSql(DeclarativePlSql object) Sets the ComplexType that owns this attribute.

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, 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, setProperties

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

PlSqlParameter

public PlSqlParameter()

Constructs a new object type attribute.

PlSqlParameter

public PlSqlParameter(java.lang.String name)

Constructs a new object type attribute with the specified name.

Parameters:

name - a string containing the attribute name

PlSqlParameter

public PlSqlParameter(java.lang.String name,
                      DataType dataType)

Constructs a new attribute with the specified name and datatype.

Parameters:

name - a string containing the attribute name

dataType - the datatype of the attribute

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

getPlSql

public DeclarativePlSql getPlSql()

Gets the PL/SQL routine that owns this parameter.

Returns:

the method, procedure or function that owns this parameter

getDataTypeID

public DBObjectID getDataTypeID()

setDataTypeID

public void setDataTypeID(DBObjectID dataTypeID)

getMode

public PlSqlParameter.Mode getMode()

setMode

public void setMode(PlSqlParameter.Mode mode)

getDefaultValue

public java.lang.String getDefaultValue()

setDefaultValue

public void setDefaultValue(java.lang.String def)

setNoCopy

public void setNoCopy(boolean noCopy)

isNoCopy

public boolean isNoCopy()

setPlSql

public void setPlSql(DeclarativePlSql object)

Sets the ComplexType that owns this attribute.

Parameters:

relation - the object type that owns this attribute.

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.

getDataType

@Deprecated
public DataType getDataType()

Deprecated. use getDataTypeID() instead

getDataType

@Deprecated
public void getDataType(DataType datatype)

Deprecated. use setDataTypeID(oracle.javatools.db.DBObjectID) instead

getReferenceIDsImpl

protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)

Description copied from class: AbstractDBObject

Used by the final getReferenceID() implementation. The list should not contain null values, or be null. Subclasses should start with super.getReferenceIDsImpl() and then add to the passed list as appopriate.

Overrides:

getReferenceIDsImpl in class AbstractDBObject

Parameters:

refs - the collection of ids this object references

Skip navigation links