oracle.javatools.db.sql

Class BuiltInFunctionArgument

java.lang.Object

oracle.javatools.db.AbstractDBObject

oracle.javatools.db.AbstractBuildableObject

oracle.javatools.db.AbstractChildBuildableObject

oracle.javatools.db.sql.BuiltInFunctionArgument

All Implemented Interfaces:

ChildDBObject, DBObject, SQLCallableArgument, Copyable, DynamicPropertySet

public class BuiltInFunctionArgument
extends AbstractChildBuildableObject
implements SQLCallableArgument

An argument to a SQL Built-in Function

Since:

12.1.3

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

Method Summary

Methods

Modifier and Type	Method and Description
DBObjectID	getDataTypeID() Get the id of the datatype of the argument
java.lang.String	getType() Returns the type of this object.
boolean	isOptional() Is the argument is optional
void	setDataTypeID(DBObjectID dataTypeID) Set the id of the datatype of the argument
void	setOptional(boolean optional) Set whether the argument is optional

Methods inherited from class oracle.javatools.db.AbstractChildBuildableObject

setParent

Methods inherited from class oracle.javatools.db.AbstractBuildableObject

checkInit, checkInit, copyToImpl, 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, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getID, getName, 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.sql.SQLCallableArgument

getName

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

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

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperty, getProperty, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

BuiltInFunctionArgument

public BuiltInFunctionArgument()

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

Returns:

a string describing the type of object.

setDataTypeID

public void setDataTypeID(DBObjectID dataTypeID)

Set the id of the datatype of the argument

getDataTypeID

public DBObjectID getDataTypeID()

Get the id of the datatype of the argument

Specified by:

getDataTypeID in interface SQLCallableArgument

Returns:

The id of the argument datatype (or an approximation) if known.

setOptional

public void setOptional(boolean optional)

Set whether the argument is optional

isOptional

public boolean isOptional()

Is the argument is optional

Specified by:

isOptional in interface SQLCallableArgument

Returns:

True if the argument is optional. False otherwise.