Package com.progress.open4gl.javaproxy

Class ParamArray

java.lang.Object

com.progress.open4gl.javaproxy.ParamArray

public class ParamArray
extends Object

An object containing an array for passing parameters to an ABL procedure or user-defined function.

Field Summary

Fields

Modifier and Type	Field	Description
protected MetaSchema	m_metaSchema
protected final ParameterSet	m_params

Constructor Summary

Constructors

Constructor	Description
ParamArray(int numParams)	Creates a parameter set object

Method Summary

Modifier and Type	Method	Description
void	addCharacter(int position, String val, int mode)	Adds a Character parameter
void	addCharacterArray(int position, String[] val, int mode, int extentValue)	Adds a Character array parameter
void	addCOMHandle(int position, COMHandle val, int mode)	Adds a COMHandle parameter
void	addCOMHandleArray(int position, COMHandle[] val, int mode, int extentValue)	Adds a COMHandle array parameter
void	addDataset(int position, ProDataGraph val, int mode, ProDataGraphMetaData metadata)	Adds a Dataset parameter as a ProDataGraph object
void	addDataset(int position, String val, int mode)	Adds a Dataset parameter (Version for serialized dataset)
void	addDataset(int position, String val, int mode, boolean writeBeforeImage)	Adds a Dataset parameter (Version for serialized dataset)
void	addDataset(int position, String val, int mode, boolean writeBeforeImage, int serializeFormat)	Adds a Dataset parameter (Version for serialized dataset)
void	addDatasetHandle(int position, ProDataGraph val, int mode, ProDataGraphMetaData metadata)	Adds a Dataset Handle parameter as a ProDataGraph object
void	addDatasetHandle(int position, String val, int mode)	Adds a Dataset Handle parameter (Version for serialized dataset)
void	addDatasetHandle(int position, String val, int mode, boolean writeBeforeImage)	Adds a Dataset Handle parameter (Version for serialized dataset)
void	addDatasetHandle(int position, String val, int mode, boolean writeBeforeImage, int serializeFormat)	Adds a Dataset Handle parameter (Version for serialized dataset)
void	addDate(int position, GregorianCalendar val, int mode)	Adds a Date parameter
void	addDateArray(int position, GregorianCalendar[] val, int mode, int extentValue)	Adds a Date array parameter
void	addDatetime(int position, GregorianCalendar val, int mode)	Adds a DateTime parameter
void	addDatetimeArray(int position, GregorianCalendar[] val, int mode, int extentValue)	Adds a DateTime array parameter
void	addDatetimeTZ(int position, GregorianCalendar val, int mode)	Adds a DateTimeTZ parameter
void	addDatetimeTZArray(int position, GregorianCalendar[] val, int mode, int extentValue)	Adds a DateTimeTZ array parameter
void	addDecimal(int position, BigDecimal val, int mode)	Adds a Decimal parameter
void	addDecimalArray(int position, BigDecimal[] val, int mode, int extentValue)	Adds a Decimal array parameter
void	addHandle(int position, Handle val, int mode)	Adds a Handle parameter
void	addHandleArray(int position, Handle[] val, int mode, int extentValue)	Adds a Handle array parameter
void	addInt64(int position, long val, int mode)	Adds an Int64 parameter
void	addInt64(int position, Long val, int mode)	Adds an Int64 parameter
void	addInt64Array(int position, long[] val, int mode, int extentValue)	Adds an Int64 array parameter
void	addInt64Array(int position, Long[] val, int mode, int extentValue)	Adds an Int64 array parameter
void	addInteger(int position, int val, int mode)	Adds an Integer parameter
void	addInteger(int position, Integer val, int mode)	Adds an Integer parameter
void	addIntegerArray(int position, int[] val, int mode, int extentValue)	Adds an Integer array parameter
void	addIntegerArray(int position, Integer[] val, int mode, int extentValue)	Adds an Integer array parameter
void	addLogical(int position, boolean val, int mode)	Adds a Logical parameter
void	addLogical(int position, Boolean val, int mode)	Adds a Logical parameter
void	addLogicalArray(int position, boolean[] val, int mode, int extentValue)	Adds a Logical array parameter
void	addLogicalArray(int position, Boolean[] val, int mode, int extentValue)	Adds a Logical array parameter
void	addLongchar(int position, String val, int mode)	Adds a LongChar parameter
void	addLongcharArray(int position, String[] val, int mode, int extentValue)	Adds a LongChar array parameter
void	addMemptr(int position, Memptr val, int mode)	Adds a Memptr parameter
void	addMemptrArray(int position, Memptr[] val, int mode, int extentValue)	Adds a Memptr array parameter
void	addParameter(int position, Object obj, int paramMode, int proType, int extentValue, ProDataGraphMetaData metadata)	A Generic means of adding a parameter
void	addParameter(int position, Object obj, int paramMode, int proType, int extentValue, ProResultSetMetaDataImpl metadata)	A Generic means of adding a parameter
void	addRaw(int position, byte[] val, int mode)	Adds a Raw parameter
void	addRawArray(int position, byte[][] val, int mode, int extentValue)	Adds a Raw array parameter
void	addRecid(int position, long val, int mode)	Adds a Recid parameter
void	addRecid(int position, Long val, int mode)	Adds a Recid parameter
void	addRecidArray(int position, long[] val, int mode, int extentValue)	Adds a Recid array parameter
void	addRecidArray(int position, Long[] val, int mode, int extentValue)	Adds a Recid array parameter
void	addRowid(int position, Rowid val, int mode)	Adds a Rowid parameter
void	addRowidArray(int position, Rowid[] val, int mode, int extentValue)	Adds a Rowid array parameter
void	addTable(int position, ProDataGraph val, int mode, ProDataGraphMetaData metadata)	Adds a Temp-Table parameter as a ProDataGraph object
void	addTable(int position, String val, int mode)	Adds a Temp-Table parameter as a serialized string
void	addTable(int position, String val, int mode, int serializeFormat)	Adds a Temp-Table parameter as a serialized string
void	addTable(int position, ResultSet val, int mode, ProResultSetMetaDataImpl metadata)	Adds a Temp-Table parameter as a ResultSet object
void	addTableHandle(int position, ProDataGraph val, int mode, ProDataGraphMetaData metadata)	Adds a Table Handle parameter as a ProDataGraph object
void	addTableHandle(int position, String val, int mode)	Adds a Table Handle parameter (Version for serialized temp-table)
void	addTableHandle(int position, String val, int mode, int serializeFormat)	Adds a Table Handle parameter (Version for serialized temp-table)
void	addTableHandle(int position, ResultSet val, int mode, ProResultSetMetaDataImpl metadata)	Adds a Table Handle parameter as a ResultSet object
void	clear()	Clears the object for reuse
InputErrorResetPolicy	getInputErrorResetPolicy()	Retrieve the current value for the InputErrorResetPolicy setting.
OutputErrorResetPolicy	getOutputErrorResetPolicy()	Retrieve the current value of the OutputErrorResetPolicy setting.
Object	getOutputParameter(int position)	After running a procedure or user-defined function, use this to access the OUTPUT parameters.
String	getProcReturnString()	Retrieves the return value of the method most recently run.
Object	getReturnValue()
void	setInputErrorResetPolicy(InputErrorResetPolicy policy)	Assign the policy that controls the reset behavior of the ParamArray when an error occurs processing the input side of an appserver request.
void	setIsReturnExtent(boolean bIsReturnExtent)	Allows you to specify whether the return type for a user-defined function is an extent (array)
void	setIsReturnUnknown(boolean bIsReturnUnknown)	Allows you to specify whether the the return value for a user-defined function can be Unknown
void	setOutputErrorResetPolicy(OutputErrorResetPolicy policy)	Assign the policy that controls the reset behavior of the ParamArray when an error occurs processing the output side of an appserver request.
void	setReturnType(int value)	Allows you to specify the return type for a user-defined function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

m_params

protected final ParameterSet m_params

m_metaSchema

protected MetaSchema m_metaSchema

Constructor Details

ParamArray

public ParamArray(int numParams)

Creates a parameter set object

Parameters:

numParams - number of parameters being passed

Method Details

setInputErrorResetPolicy

public void setInputErrorResetPolicy(InputErrorResetPolicy policy)

Assign the policy that controls the reset behavior of the ParamArray when an error occurs processing the input side of an appserver request.

Parameters:

policy -

getInputErrorResetPolicy

public InputErrorResetPolicy getInputErrorResetPolicy()

Retrieve the current value for the InputErrorResetPolicy setting.

Returns:

setOutputErrorResetPolicy

public void setOutputErrorResetPolicy(OutputErrorResetPolicy policy)

Assign the policy that controls the reset behavior of the ParamArray when an error occurs processing the output side of an appserver request.

Parameters:

policy -

getOutputErrorResetPolicy

public OutputErrorResetPolicy getOutputErrorResetPolicy()

Retrieve the current value of the OutputErrorResetPolicy setting.

Returns:

clear

public void clear()

Clears the object for reuse

addLogical

public void addLogical(int position,
 boolean val,
 int mode)
                throws Open4GLException

Adds a Logical parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addLogicalArray

public void addLogicalArray(int position,
 boolean[] val,
 int mode,
 int extentValue)
                     throws Open4GLException

Adds a Logical array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addInteger

public void addInteger(int position,
 int val,
 int mode)
                throws Open4GLException

Adds an Integer parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addIntegerArray

public void addIntegerArray(int position,
 int[] val,
 int mode,
 int extentValue)
                     throws Open4GLException

Adds an Integer array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addInt64

public void addInt64(int position,
 long val,
 int mode)
              throws Open4GLException

Adds an Int64 parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addInt64Array

public void addInt64Array(int position,
 long[] val,
 int mode,
 int extentValue)
                   throws Open4GLException

Adds an Int64 array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addRecid

public void addRecid(int position,
 long val,
 int mode)
              throws Open4GLException

Adds a Recid parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addRecidArray

public void addRecidArray(int position,
 long[] val,
 int mode,
 int extentValue)
                   throws Open4GLException

Adds a Recid array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addLogical

public void addLogical(int position,
 Boolean val,
 int mode)
                throws Open4GLException

Adds a Logical parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addLogicalArray

public void addLogicalArray(int position,
 Boolean[] val,
 int mode,
 int extentValue)
                     throws Open4GLException

Adds a Logical array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addInteger

public void addInteger(int position,
 Integer val,
 int mode)
                throws Open4GLException

Adds an Integer parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addIntegerArray

public void addIntegerArray(int position,
 Integer[] val,
 int mode,
 int extentValue)
                     throws Open4GLException

Adds an Integer array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addInt64

public void addInt64(int position,
 Long val,
 int mode)
              throws Open4GLException

Adds an Int64 parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addInt64Array

public void addInt64Array(int position,
 Long[] val,
 int mode,
 int extentValue)
                   throws Open4GLException

Adds an Int64 array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addRecid

public void addRecid(int position,
 Long val,
 int mode)
              throws Open4GLException

Adds a Recid parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addRecidArray

public void addRecidArray(int position,
 Long[] val,
 int mode,
 int extentValue)
                   throws Open4GLException

Adds a Recid array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addDecimal

public void addDecimal(int position,
 BigDecimal val,
 int mode)
                throws Open4GLException

Adds a Decimal parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addDecimalArray

public void addDecimalArray(int position,
 BigDecimal[] val,
 int mode,
 int extentValue)
                     throws Open4GLException

Adds a Decimal array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addCharacter

public void addCharacter(int position,
 String val,
 int mode)
                  throws Open4GLException

Adds a Character parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addCharacterArray

public void addCharacterArray(int position,
 String[] val,
 int mode,
 int extentValue)
                       throws Open4GLException

Adds a Character array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addLongchar

public void addLongchar(int position,
 String val,
 int mode)
                 throws Open4GLException

Adds a LongChar parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addLongcharArray

public void addLongcharArray(int position,
 String[] val,
 int mode,
 int extentValue)
                      throws Open4GLException

Adds a LongChar array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addDate

public void addDate(int position,
 GregorianCalendar val,
 int mode)
             throws Open4GLException

Adds a Date parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addDateArray

public void addDateArray(int position,
 GregorianCalendar[] val,
 int mode,
 int extentValue)
                  throws Open4GLException

Adds a Date array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addDatetime

public void addDatetime(int position,
 GregorianCalendar val,
 int mode)
                 throws Open4GLException

Adds a DateTime parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addDatetimeArray

public void addDatetimeArray(int position,
 GregorianCalendar[] val,
 int mode,
 int extentValue)
                      throws Open4GLException

Adds a DateTime array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addDatetimeTZ

public void addDatetimeTZ(int position,
 GregorianCalendar val,
 int mode)
                   throws Open4GLException

Adds a DateTimeTZ parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addDatetimeTZArray

public void addDatetimeTZArray(int position,
 GregorianCalendar[] val,
 int mode,
 int extentValue)
                        throws Open4GLException

Adds a DateTimeTZ array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addRaw

public void addRaw(int position,
 byte[] val,
 int mode)
            throws Open4GLException

Adds a Raw parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addRawArray

public void addRawArray(int position,
 byte[][] val,
 int mode,
 int extentValue)
                 throws Open4GLException

Adds a Raw array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addRowid

public void addRowid(int position,
 Rowid val,
 int mode)
              throws Open4GLException

Adds a Rowid parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addRowidArray

public void addRowidArray(int position,
 Rowid[] val,
 int mode,
 int extentValue)
                   throws Open4GLException

Adds a Rowid array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addMemptr

public void addMemptr(int position,
 Memptr val,
 int mode)
               throws Open4GLException

Adds a Memptr parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addMemptrArray

public void addMemptrArray(int position,
 Memptr[] val,
 int mode,
 int extentValue)
                    throws Open4GLException

Adds a Memptr array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addHandle

public void addHandle(int position,
 Handle val,
 int mode)
               throws Open4GLException

Adds a Handle parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addHandleArray

public void addHandleArray(int position,
 Handle[] val,
 int mode,
 int extentValue)
                    throws Open4GLException

Adds a Handle array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addCOMHandle

public void addCOMHandle(int position,
 COMHandle val,
 int mode)
                  throws Open4GLException

Adds a COMHandle parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addCOMHandleArray

public void addCOMHandleArray(int position,
 COMHandle[] val,
 int mode,
 int extentValue)
                       throws Open4GLException

Adds a COMHandle array parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

extentValue - Specifies extent of the array

Throws:

Open4GLException

addTable

public void addTable(int position,
 ResultSet val,
 int mode,
 ProResultSetMetaDataImpl metadata)
              throws Open4GLException

Adds a Temp-Table parameter as a ResultSet object

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

metadata - Specifies the table's meta data

Throws:

Open4GLException

addTableHandle

public void addTableHandle(int position,
 ResultSet val,
 int mode,
 ProResultSetMetaDataImpl metadata)
                    throws Open4GLException

Adds a Table Handle parameter as a ResultSet object

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

metadata - Specifies the table's meta data

Throws:

Open4GLException

addTable

public void addTable(int position,
 ProDataGraph val,
 int mode,
 ProDataGraphMetaData metadata)
              throws Open4GLException

Adds a Temp-Table parameter as a ProDataGraph object

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

metadata - Specifies the table's meta data

Throws:

Open4GLException

addTable

public void addTable(int position,
 String val,
 int mode)
              throws Open4GLException

Adds a Temp-Table parameter as a serialized string

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addTable

public void addTable(int position,
 String val,
 int mode,
 int serializeFormat)
              throws Open4GLException

Adds a Temp-Table parameter as a serialized string

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

serializeFormat - Specifies how Temp-table gets serialized (1 for XML, 2 for JSON)

Throws:

Open4GLException

addTableHandle

public void addTableHandle(int position,
 ProDataGraph val,
 int mode,
 ProDataGraphMetaData metadata)
                    throws Open4GLException

Adds a Table Handle parameter as a ProDataGraph object

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

metadata - Specifies the table's meta data

Throws:

Open4GLException

addTableHandle

public void addTableHandle(int position,
 String val,
 int mode)
                    throws Open4GLException

Adds a Table Handle parameter (Version for serialized temp-table)

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies serialized temp-table, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addTableHandle

public void addTableHandle(int position,
 String val,
 int mode,
 int serializeFormat)
                    throws Open4GLException

Adds a Table Handle parameter (Version for serialized temp-table)

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies serialized temp-table, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

serializeFormat - Specifies how Temp-table gets serialized (1 for XML, 2 for JSON)

Throws:

Open4GLException

addDataset

public void addDataset(int position,
 ProDataGraph val,
 int mode,
 ProDataGraphMetaData metadata)
                throws Open4GLException

Adds a Dataset parameter as a ProDataGraph object

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

metadata - Specifies the dataset's meta data

Throws:

Open4GLException

addDataset

public void addDataset(int position,
 String val,
 int mode)
                throws Open4GLException

Adds a Dataset parameter (Version for serialized dataset)

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addDataset

public void addDataset(int position,
 String val,
 int mode,
 boolean writeBeforeImage)
                throws Open4GLException

Adds a Dataset parameter (Version for serialized dataset)

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

writeBeforeImage - Specifies whether to serialize the dataset with before-image data

Throws:

Open4GLException

addDataset

public void addDataset(int position,
 String val,
 int mode,
 boolean writeBeforeImage,
 int serializeFormat)
                throws Open4GLException

Adds a Dataset parameter (Version for serialized dataset)

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

writeBeforeImage - Specifies whether to serialize the dataset with before-image data

serializeFormat - Specifies how Dataset gets serialized (1 for XML, 2 for JSON)

Throws:

Open4GLException

addDatasetHandle

public void addDatasetHandle(int position,
 ProDataGraph val,
 int mode,
 ProDataGraphMetaData metadata)
                      throws Open4GLException

Adds a Dataset Handle parameter as a ProDataGraph object

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies a variable that contains its value, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

metadata - Specifies the dataset's meta data

Throws:

Open4GLException

addDatasetHandle

public void addDatasetHandle(int position,
 String val,
 int mode)
                      throws Open4GLException

Adds a Dataset Handle parameter (Version for serialized dataset)

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies serialized dataset, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

Throws:

Open4GLException

addDatasetHandle

public void addDatasetHandle(int position,
 String val,
 int mode,
 boolean writeBeforeImage)
                      throws Open4GLException

Adds a Dataset Handle parameter (Version for serialized dataset)

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies serialized dataset, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

writeBeforeImage - Specifies whether to serialize the dataset with before-image data

Throws:

Open4GLException

addDatasetHandle

public void addDatasetHandle(int position,
 String val,
 int mode,
 boolean writeBeforeImage,
 int serializeFormat)
                      throws Open4GLException

Adds a Dataset Handle parameter (Version for serialized dataset)

Parameters:

position - Specifies the 0-based index indicating the parameter position

val - Specifies serialized dataset, or null for an OUTPUT parameter

mode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

writeBeforeImage - Specifies whether to serialize the dataset with before-image data

serializeFormat - Specifies how Dataset gets serialized (1 for XML, 2 for JSON)

Throws:

Open4GLException

getOutputParameter

public Object getOutputParameter(int position)
                          throws Open4GLException

After running a procedure or user-defined function, use this to access the OUTPUT parameters. The output value is always returned as an Object. You need to cast the Object and assign it to the output variable you have created.

Parameters:

position - Specifies the 0-based index indicating the parameter position

Throws:

Open4GLException

addParameter

public void addParameter(int position,
 Object obj,
 int paramMode,
 int proType,
 int extentValue,
 ProResultSetMetaDataImpl metadata)
                  throws Open4GLException

A Generic means of adding a parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

obj - Specifies a variable of the appropriate data type containing parameter value, or null for OUTPUT parameter.

paramMode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

proType - Specifies its ABL data type (use constants in com.progress.open4gl.Parameter class)

extentValue - Specifies the extent of array, zero for a scalar value

metadata - Specifies schema for parameter when proType is: Parameter.PRO_TEMPTABLE or PRO_TABLEHANDLE

Throws:

Open4GLException

addParameter

public void addParameter(int position,
 Object obj,
 int paramMode,
 int proType,
 int extentValue,
 ProDataGraphMetaData metadata)
                  throws Open4GLException

A Generic means of adding a parameter

Parameters:

position - Specifies the 0-based index indicating the parameter position

obj - Specifies a variable of the appropriate data type containing parameter value, or null for OUTPUT parameter.

paramMode - Specifies the parameter's ABL mode: either ParamArrayMode.INPUT, INPUT_OUTPUT or OUTPUT

proType - Specifies its ABL data type (use constants in com.progress.open4gl.Parameter class)

extentValue - Specifies the extent of array, zero for a scalar value

metadata - Specifies schema for parameter when proType is: Parameter.PRO_DATASET, PRO_DATASETHANDLE, PRO_TEMPTABLE, or PRO_TABLEHANDLE

Throws:

Open4GLException

setReturnType

public void setReturnType(int value)
                   throws Open4GLException

Allows you to specify the return type for a user-defined function.

Parameters:

value - Specifies ABL data type returned by user-defined function (use constants in com.progress.open4gl.Parameter class)

Throws:

Open4GLException

getReturnValue

public Object getReturnValue()

setIsReturnExtent

public void setIsReturnExtent(boolean bIsReturnExtent)

Allows you to specify whether the return type for a user-defined function is an extent (array)

Parameters:

bIsReturnExtent - If true, return type is an extent (array)

setIsReturnUnknown

public void setIsReturnUnknown(boolean bIsReturnUnknown)

Allows you to specify whether the the return value for a user-defined function can be Unknown

Parameters:

bIsReturnUnknown - If true, return value can be Unknown

getProcReturnString

public String getProcReturnString()

Retrieves the return value of the method most recently run.