Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.tools.schemaframework
Class StoredProcedureDefinition

java.lang.Object
  extended byoracle.toplink.tools.schemaframework.DatabaseObjectDefinition
      extended byoracle.toplink.tools.schemaframework.StoredProcedureDefinition

All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class StoredProcedureDefinition
extends DatabaseObjectDefinition

Purpose: Allow a semi-generic way of creating store procedures.

See Also:
Serialized Form

Field Summary

Fields inherited from class oracle.toplink.tools.schemaframework.DatabaseObjectDefinition
name, qualifier

Constructor Summary
StoredProcedureDefinition()

Method Summary
void addArgument(FieldDefinition argument)
The arguments are the names of the parameters to the procedure.
void addArgument(java.lang.String argumentName, java.lang.Class type)
The arguments are the names of the parameters to the procedure.
void addArgument(java.lang.String argumentName, java.lang.Class type, int size)
The arguments are the names of the parameters to the procedure.
void addArgument(java.lang.String argumentName, java.lang.String typeName)
The arguments are the names of the parameters to the procedure.
void addInOutputArgument(FieldDefinition argument)
The output arguments are used to get values back from the proc, such as cursors.
void addInOutputArgument(java.lang.String argumentName, java.lang.Class type)
The output arguments are used to get values back from the proc.
void addOutputArgument(FieldDefinition argument)
The output arguments are used to get values back from the proc, such as cursors.
void addOutputArgument(java.lang.String argumentName, java.lang.Class type)
The output arguments are used to get values back from the proc.
void addOutputArgument(java.lang.String argumentName, java.lang.Class type, int size)
The output arguments are used to get values back from the proc.
void addOutputArgument(java.lang.String argumentName, java.lang.String typeName)
The output arguments are used to get values back from the proc, such as cursors.
void addStatement(java.lang.String statement)
The statements are the SQL lines of code in procedure.
void addVariable(FieldDefinition variable)
The variables are the names of the declared variables used in the procedure.
void addVariable(java.lang.String variableName, java.lang.String typeName)
The variables are the names of the declared variables used in the procedure.
java.util.Vector getArguments()
The arguments are the names of the parameters to the procedure.
java.util.Vector getInOutputArguments()
The output arguments are used to get values back from the proc, such as cursors.
java.util.Vector getOutputArguments()
The output arguments are used to get values back from the proc, such as cursors.
java.util.Vector getStatements()
The statements are the SQL lines of code in procedure.
java.util.Vector getVariables()
The variables are the names of the declared variables used in the procedure.
void setArguments(java.util.Vector arguments)
The arguments are the field defs of the parameters names and types to the procedure.
void setInOutputArguments(java.util.Vector inOutputArguments)
The output arguments are used to get values back from the proc, such as cursors.
void setOutputArguments(java.util.Vector outputArguments)
The output arguments are used to get values back from the proc, such as cursors.
void setStatements(java.util.Vector statements)
The statements are the SQL lines of code in procedure.
void setVariables(java.util.Vector variables)
The variables are the field defs of the declared variables used in the procedure.

Methods inherited from class oracle.toplink.tools.schemaframework.DatabaseObjectDefinition
getName, getQualifier, setName, setQualifier, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StoredProcedureDefinition

public StoredProcedureDefinition()

Method Detail

addArgument

public void addArgument(java.lang.String argumentName,
                        java.lang.Class type)
The arguments are the names of the parameters to the procedure.

addArgument

public void addArgument(java.lang.String argumentName,
                        java.lang.Class type,
                        int size)
The arguments are the names of the parameters to the procedure.

addArgument

public void addArgument(java.lang.String argumentName,
                        java.lang.String typeName)
The arguments are the names of the parameters to the procedure.

addArgument

public void addArgument(FieldDefinition argument)
The arguments are the names of the parameters to the procedure.

addInOutputArgument

public void addInOutputArgument(java.lang.String argumentName,
                                java.lang.Class type)
The output arguments are used to get values back from the proc.

addInOutputArgument

public void addInOutputArgument(FieldDefinition argument)
The output arguments are used to get values back from the proc, such as cursors.

addOutputArgument

public void addOutputArgument(java.lang.String argumentName,
                              java.lang.Class type)
The output arguments are used to get values back from the proc.

addOutputArgument

public void addOutputArgument(java.lang.String argumentName,
                              java.lang.Class type,
                              int size)
The output arguments are used to get values back from the proc.

addOutputArgument

public void addOutputArgument(java.lang.String argumentName,
                              java.lang.String typeName)
The output arguments are used to get values back from the proc, such as cursors.

addOutputArgument

public void addOutputArgument(FieldDefinition argument)
The output arguments are used to get values back from the proc, such as cursors.

addStatement

public void addStatement(java.lang.String statement)
The statements are the SQL lines of code in procedure.

addVariable

public void addVariable(java.lang.String variableName,
                        java.lang.String typeName)
The variables are the names of the declared variables used in the procedure.

addVariable

public void addVariable(FieldDefinition variable)
The variables are the names of the declared variables used in the procedure.

getArguments

public java.util.Vector getArguments()
The arguments are the names of the parameters to the procedure.

getInOutputArguments

public java.util.Vector getInOutputArguments()
The output arguments are used to get values back from the proc, such as cursors.

getOutputArguments

public java.util.Vector getOutputArguments()
The output arguments are used to get values back from the proc, such as cursors.

getStatements

public java.util.Vector getStatements()
The statements are the SQL lines of code in procedure.

getVariables

public java.util.Vector getVariables()
The variables are the names of the declared variables used in the procedure.

setArguments

public void setArguments(java.util.Vector arguments)
The arguments are the field defs of the parameters names and types to the procedure.

setInOutputArguments

public void setInOutputArguments(java.util.Vector inOutputArguments)
The output arguments are used to get values back from the proc, such as cursors.

setOutputArguments

public void setOutputArguments(java.util.Vector outputArguments)
The output arguments are used to get values back from the proc, such as cursors.

setStatements

public void setStatements(java.util.Vector statements)
The statements are the SQL lines of code in procedure.

setVariables

public void setVariables(java.util.Vector variables)
The variables are the field defs of the declared variables used in the procedure.

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.