com.crystaldecisions.sdk.occa.report.data
Interface IProcedure

All Superinterfaces:
IClone, ITable
All Known Subinterfaces:
ICommandTable
All Known Implementing Classes:
CommandTable, Procedure

public interface IProcedure
extends ITable

This interface is used to get and set the current values for the parameters of stored procedures. The Procedure object represents a procedure that is stored in the database. These procedures are referred to as "stored procedures."

Procedures are stored in the database to avoid undue network traffic. For example, a long SQL statement can be stored in the database to avoid passing it back and forth over the network. It is also possible for the stored procedure to have parameters. In this case, only the argument values need to be transferred across the network. If a report connects to a database that has a stored procedure, and that stored procedure has parameters, the IDataDefinition.getParameterFields() method will return these parameters. You cannot change the definition of these parameters, but it is possible to modify their current values. Additionally, the procedure is stored in the table in a manner similar to a normal record. Use the com.crystaldecisions.sdk.occa.report.application.RowsetController#browseFieldValues method to examine the contents of the stored procedure.


Method Summary
 Fields<IParameterField> getParameters()
          Gets the stored procedure parameters as Fields objects.
 void setParameters(Fields<IParameterField> parameters)
          Sets the stored procedure parameters as Fields objects.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.ITable
getAlias, getConnection, getConnectionInfo, getDataFields, getDescription, getIndexes, getName, getQualifiedName, setAlias, setConnection, setConnectionInfo, setDataFields, setDescription, setIndexes, setName, setQualifiedName
 

Method Detail

getParameters

Fields<IParameterField> getParameters()
Gets the stored procedure parameters as Fields objects.

Returns:
The parameters as Fields objects.

setParameters

void setParameters(Fields<IParameterField> parameters)
Sets the stored procedure parameters as Fields objects.

Parameters:
parameters - The parameters as Fields objects.