|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.iplanet.jato.model.sql.StoredProcSchema
The schema containing the stored procedure metadata. The metadata provides the
minimum required details such as the procedure name and descriptions of any
input, output and result parameters.
The StoredProcModelBase
implementation uses this metadata
to prepare the CallableStatement.
StoredProcModel
,
StoredProcModelBase
,
StoredProcParameterDescriptor
, Serialized FormConstructor Summary | |
StoredProcSchema()
Default constructor |
Method Summary | |
void |
addParameterDescriptor(StoredProcParameterDescriptor descriptor)
Adds an input or output parameter descriptor to the schema. |
int |
getNumParameters()
Returns the total number of input and output parameters for the procedure. |
StoredProcParameterDescriptor |
getParameterDescriptor(int index)
Returns the parameter descriptor at the supplied index from the internal parameter descriptor array. |
StoredProcParameterDescriptor |
getParameterDescriptor(java.lang.String name)
Returns the parameter descriptor for a specific parameter. |
StoredProcParameterDescriptor[] |
getParameterDescriptors()
Returns the array of StoredProcParameterDescriptor which contains all the StoredProcParameterDescriptors for the input and output parameters. |
java.lang.String |
getProcedureName()
Returns the name of the stored procedure. |
StoredProcParameterDescriptor |
getResultParameterDescriptor()
Returns the StoredProcParameterDescriptor which describes the result paramter. |
boolean |
hasResultParameter()
Returns true if the procedure has a result parameter, false otherwise. |
void |
setProcedureName(java.lang.String value)
Sets the name of the stored procedure. |
void |
setResultParameterDescriptor(StoredProcParameterDescriptor value)
Sets the result parameter descriptor in the schema. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public StoredProcSchema()
Method Detail |
public java.lang.String getProcedureName()
public void setProcedureName(java.lang.String value)
value
- The stored procedure name.public int getNumParameters()
public boolean hasResultParameter()
public StoredProcParameterDescriptor getResultParameterDescriptor()
public void setResultParameterDescriptor(StoredProcParameterDescriptor value)
value
- The StoredProcParameterDescriptor which describes the result
parameter.public StoredProcParameterDescriptor[] getParameterDescriptors()
public void addParameterDescriptor(StoredProcParameterDescriptor descriptor)
descriptor
- A StoredProcParameterDescriptor which describes a particular
input or output parameter.java.lang.IllegalArgumentException
- Thrown if the supplied descriptor parameter describes the result
parameter.setResultParameterDescriptor(StoredProcParameterDescriptor)
public StoredProcParameterDescriptor getParameterDescriptor(int index)
public StoredProcParameterDescriptor getParameterDescriptor(java.lang.String name)
StoredProcParameterDescriptor.getName()
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |