DataFaucet 1.0 Beta

datafaucet.system.sql
Class procedure

WEB-INF.cftags.component
        extended by datafaucet.system.sql.duck
            extended by datafaucet.system.sql.procedure

public class procedure
extends duck

stores parameters for execution of a specified stored procedure


Constructor Summary
init(string procedure='[runtime expression]', [string results='[runtime expression]'], [struct parameters='[runtime expression]'], [string null='[runtime expression]'], [boolean nulldefaults='[runtime expression]'], [string maxrows='[runtime expression]'], [boolean debug='[runtime expression]'], [string returnCode='[runtime expression]'], [numeric blockfactor='[runtime expression]'], [any datasource=''])
 
Method Summary
 void addListener(any listener, string method)
private any broadcast([any resultset=''])
 struct execute()
 any getDatasource()
private any getListeners()
private any getNewListener()
 any getParam(string parameter)
 query getParameters()
private any getSQLAgent()
 string getSyntax()
private boolean hasListeners()
private any notifyListener(any listener, [any resultSet=''])
 any param(string parameter, string paramvalue)
 any setDatasource([any datasource=''])
 any setNull(string parameter)
private void set_parameters(string propertyname, struct propertyvalue)
private void set_procedure(string propertyname, string propertyvalue)
 
Methods inherited from class datafaucet.system.sql.duck
arg, getDefaultLocalization, getLocalization, getNext, getObject, getProperties, getProperty, getPropertylist, getTail, getValue, hasNext, identifyAccessorOrMutator, insertAfter, onMissingMethod, parseDate, parseNumber, raiseAbstractClassException, raiseMissingMethodException, removeAfter, setLocalization, setNext, setProperties, setProperty, setValue, simplify
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(string procedure='[runtime expression]', [string results='[runtime expression]'], [struct parameters='[runtime expression]'], [string null='[runtime expression]'], [boolean nulldefaults='[runtime expression]'], [string maxrows='[runtime expression]'], [boolean debug='[runtime expression]'], [string returnCode='[runtime expression]'], [numeric blockfactor='[runtime expression]'], [any datasource=''])

Parameters:
procedure - a table name or fragment to search for - may include % wildcard character
results - a list or array of names for desired result sets
parameters - table column data is cached in the application scope -- this flag allows the cache to be cleared
null - if true nulls are passed to the procedure for missing parameters, otherwise the procedure aborts at the first missing parameter and uses database defaults
nulldefaults - if true nulls are passed to the procedure for missing parameters, otherwise the procedure aborts at the first missing parameter and uses database defaults
maxrows - a list or array of maxrows for the requested result sets
debug - indicates if debugging information should be displayed for this procedure
returnCode - the name of a variable to populate in the parameters attribute with the status code returned by the procedure - status code is not populated if this attribute is an empty string
blockfactor - 1-100 - maps to the cfstoredproc tag's blockfactor attribute
datasource
Method Detail

addListener

public void addListener(any listener, string method)

Parameters:
listener
method

broadcast

private any broadcast([any resultset=''])

Parameters:
resultset

execute

public struct execute()


getDatasource

public any getDatasource()


getListeners

private any getListeners()


getNewListener

private any getNewListener()


getParam

public any getParam(string parameter)

Parameters:
parameter

getParameters

public query getParameters()


getSQLAgent

private any getSQLAgent()


getSyntax

public string getSyntax()


hasListeners

private boolean hasListeners()


notifyListener

private any notifyListener(any listener, [any resultSet=''])

Parameters:
listener
resultSet

param

public any param(string parameter, string paramvalue)

Parameters:
parameter
paramvalue

setDatasource

public any setDatasource([any datasource=''])

Parameters:
datasource

setNull

public any setNull(string parameter)

Parameters:
parameter

set_parameters

private void set_parameters(string propertyname, struct propertyvalue)

Parameters:
propertyname
propertyvalue

set_procedure

private void set_procedure(string propertyname, string propertyvalue)

Parameters:
propertyname
propertyvalue

DataFaucet 1.0 Beta