Reference Guide > Java APIs for Custom Procedures > ParameterInfo
 
ParameterInfo
This class retrieves the description of procedures’ input and output parameters.
public class ParameterInfo
Constructor Summary
ParameterInfo (String name, int type)
Creates a new ParameterInfo with the specified parameter values.
ParameterInfo (String name, int type, int direction)
ParameterInfo (String name, int type, int direction, ParameterInfo[] columns)
ParameterInfo (String name, int type, int direction, String xmlSchema, String localName, String namespaceURI)
Method Summary
ParameterInfo[]
getColumns
int
getDirection
String
getName
int
getType
String
getXmlSchema
Constructor Detail
ParameterInfo
public ParameterInfo (String name, int type)
 
Creates a new ParameterInfo with the specified parameter values.
Parameters
name—Name of the column or parameter.
type—One of the java.sql.Types: XML_STRING, TYPED_CURSOR, and GENERIC_CURSOR.
 
ParameterInfo
public ParameterInfo (String name, int type, int direction)
 
Creates a new ParameterInfo with the specified parameter values.
Parameters
name—Name of the column or parameter.
type—Types are from java.sql.Types, plus XML_STRING, TYPED_CURSOR, and GENERIC_CURSOR.
direction—The direction can be DIRECTION_IN, DIRECTION_INOUT, or DIRECTION_OUT. This value is passed as zero for column definitions.
 
ParameterInfo
public ParameterInfo (String name, int type, int direction,
ParameterInfo[] columns)
 
Creates a new ParameterInfo with the specified parameter values.
Parameters
name—Name of the column or parameter.
type—Types are from java.sql.Types, plus XML_STRING, TYPED_CURSOR, and GENERIC_CURSOR.
direction—The direction can be DIRECTION_IN, DIRECTION_INOUT, or DIRECTION_OUT. This value is passed as zero for a column definition.
columns—Non-null if the type is TYPED_CURSOR.
 
ParameterInfo
public ParameterInfo (String name, int type, int direction,
String xmlSchema, String localName,
String namespaceURI)
 
Creates a new ParameterInfo with the specified parameter values.
Parameters
name—Name of the column or parameter.
type—Types are from java.sql.Types, plus XML_STRING, TYPED_CURSOR, and GENERIC_CURSOR.
direction—The direction can be DIRECTION_IN, DIRECTION_INOUT, or DIRECTION_OUT. This value is passed as zero for column definitions.
xmlSchema—Non-null if the type is XML_STRING.
localName—Local name (element name) of the selected element.
namespaceURI—URI of the namespace for the selected element.
Method Detail
getColumns
public ParameterInfo[] getColumns()
 
This method retrieves columns.
 
Returns
This method returns columns if the column data type is TYPED_CURSOR.
getDirection
public int getDirection()
 
This method gets the direction of the parameter.
 
Returns
This method returns the direction of the parameter, which can be DIRECTION_IN, DIRECTION_INOUT, or DIRECTION_OUT.
getName
public String getName()
 
This method gets the name of the column or parameter.
Returns
This method returns the name of the column or parameter.
 
getType
public int getType()
 
This method gets the type of the column or parameter.
Returns
This method returns the type of the column or parameter. The types are from java.sql.Types, plus XML_STRING, TYPED_CURSOR, and GENERIC_CURSOR.
 
getXmlSchema
public String getXmlSchema()
 
This method gets a schema.
Returns
This method returns the schema if the type is XML_STRING.