Skip navigation links

com.sigmadynamics.server.DataServices.DatabaseProvider
Interface WriteOnlyStoredProcedure

All Known Subinterfaces:

StoredProcedure

public interface WriteOnlyStoredProcedure

This is the interface of stored procedures that can be executed either asynchronously or in batches or both. As such, they can not have results - either in the form of result sets or output parameters.

Method Summary

void	close() Close the stored procedure object.
int	execute() Executes a stored procedure.
void	flush() Flush the batch of calls
java.lang.String	getName() Returns the stored procedure name.
int	getParameterCount() Returns the number of parameters accepted by the stored procedure.
void	set(int paramIndex, byte[] value) sets a stored procedure parameter with values from a byte[].
void	set(int paramIndex, double value) sets a stored procedure parameter with a double value.
void	set(int paramIndex, java.io.InputStream value, int length) sets a stored procedure parameter with a InputStream value.
void	set(int paramIndex, int value) sets a stored procedure parameter with a int value.
void	set(int paramIndex, long value) sets a stored procedure parameter with a long value.
void	set(int paramIndex, java.lang.String value) sets a stored procedure parameter with a String value.
void	setDate(int paramIndex, long value) sets a stored procedure parameter with a long value.
void	setDate(int paramIndex, long value, java.util.Calendar cal) sets a stored procedure parameter with a long value.
void	setNull(int paramIndex)

Method Detail

set

void set(int paramIndex,
         java.lang.String value)

sets a stored procedure parameter with a String value.

The parameter set is at the ordinal position specified by the paramIndex parameter. The parameter must be either an IN or INOUT parameter.

Parameters:

paramIndex - specifies which parameter. The first parameter is 1, the second is 2, etc.

value - the value for the parameter

set

void set(int paramIndex,
         double value)

sets a stored procedure parameter with a double value.

The parameter set is at the ordinal position specified by the paramIndex parameter. The parameter must be either an IN or INOUT parameter.

Parameters:

paramIndex - specifies which parameter. The first parameter is 1, the second is 2, etc.

value - the value for the parameter

set

void set(int paramIndex,
         int value)

sets a stored procedure parameter with a int value.

The parameter set is at the ordinal position specified by the paramIndex parameter. The parameter must be either an IN or INOUT parameter.

Parameters:

paramIndex - specifies which parameter. The first parameter is 1, the second is 2, etc.

value - the value for the parameter

set

void set(int paramIndex,
         long value)

sets a stored procedure parameter with a long value.

The parameter set is at the ordinal position specified by the paramIndex parameter. The parameter must be either an IN or INOUT parameter.

Parameters:

paramIndex - specifies which parameter. The first parameter is 1, the second is 2, etc.

value - the value for the parameter

setDate

void setDate(int paramIndex,
             long value,
             java.util.Calendar cal)

sets a stored procedure parameter with a long value.

The parameter set is at the ordinal position specified by the paramIndex parameter. The parameter must be either an IN or INOUT parameter.

NB. This call will work on TIMESTAMP columns and will also work for DATE or TIME columns but you may need to obey JDBC rules about the date or time values derived from the long in order to avoid problems with drivers.

Parameters:

paramIndex - specifies which parameter. The first parameter is 1, the second is 2, etc.

value - the value for the parameter

cal - a Calendar with which to specify timezone

setDate

void setDate(int paramIndex,
             long value)

sets a stored procedure parameter with a long value.

The parameter set is at the ordinal position specified by the paramIndex parameter. The parameter must be either an IN or INOUT parameter.

NB. This call will work on TIMESTAMP columns and will also work for DATE or TIME columns but you may need to obey JDBC rules about the date or time values derived from the long in order to avoid problems with drivers.

Parameters:

paramIndex - specifies which parameter. The first parameter is 1, the second is 2, etc.

value - the value for the parameter

set

void set(int paramIndex,
         java.io.InputStream value,
         int length)

sets a stored procedure parameter with a InputStream value.

The parameter set is at the ordinal position specified by the paramIndex parameter. The parameter must be either an IN or INOUT parameter.

Parameters:

paramIndex - specifies which parameter. The first parameter is 1, the second is 2, etc.

value - the value for the parameter

set

void set(int paramIndex,
         byte[] value)

sets a stored procedure parameter with values from a byte[].

The parameter set is at the ordinal position specified by the paramIndex parameter. The parameter must be either an IN or INOUT parameter.

Parameters:

paramIndex - specifies which parameter. The first parameter is 1, the second is 2, etc.

value - the value for the parameter

setNull

void setNull(int paramIndex)

execute

int execute()

Executes a stored procedure.

Call this method to either put the call to the stored procedure in the batch (if batching) or to queue the call for execution (if not batching).

You must set all IN and INOUT parameters using the set methods before calling this method.

Returns:

returns 0

flush

void flush()

Flush the batch of calls

Call this method to execute all the calls to the stored procedure in the batch.

close

void close()

Close the stored procedure object.

It's important to call close as early as possible so that system resources can be released.

getParameterCount

int getParameterCount()

Returns the number of parameters accepted by the stored procedure.

Returns:

the number of the stored procedure parameters.

getName

java.lang.String getName()

Returns the stored procedure name.

Returns:

the name of the stored procedure.

Skip navigation links