ixActuateParm

: Constructor
: Accessing Parameter Properties
: Accessing Parameter Values

The ixActuateParm class represents a runtime parameter with a collection of member variables, representing parameter properties and values. The ixActuateParm object uses Requestor functions to get and set values within an open parameter file.

The second class of the Actuate Control Class Library, ixActuateParm, represents a runtime parameter to a report. It allows the user to retrieve values and properties and to change current values. Objects of the ixActuateParm class are instantiated automatically by the ixActuateReport object when the user needs to examine the parameter properties and values or change the current value.

Class Member Functions

Constructor

ixActuateParm(
parmName CHAR(*): NULL,
parmFileNumber SMALLINT: 0)

This function is the constructor function. It is called automatically by the ixActuateReport::getParmByName() function and other functions that retrieve parameter properties and values.

In most cases, you should not use this function to instantiate ixActuateParm objects. Instead, allow the ixActuateReport class to instantiate ixActuateParm objects, using the getFirstParm(), getNextParm(), and getParmByName() functions. This function is useful only when building complex report control applications.

Accessing Parameter Properties

Accessing Parameter Values

getCurrencyDefaultValue () RETURNING MONEY

This function returns the value of the variable parmDefaultValueCurrency.

getCurrencyValue() RETURNING MONEY

This function returns the value of the variable parmValueCurrency.

setCurrencyValue(value MONEY: 0) RETURNING SMALLINT

This function sets the value of parmValueCurrency if the parmType variable = MONEY.

getDateDefaultValue() RETURNING DATE

This function returns the value of the parmDefaultValueDate variable.

getDateValue() RETURNING DATE

This function returns the value of the parmValueDate variable.

setDateValue(value DATE: NULL) RETURNING SMALLINT

This function sets the value of parmValueDate if the parmType variable = DATE. A non-zero return code indicate that parmType is not DATE.

getDoubleDefaultValue() RETURNING FLOAT

This function returns the value of the parmDefaultValueDouble variable.

getDoubleValue() RETURNING FLOAT

This function returns the value of the parmValueDouble variable.

setDoubleValue(value FLOAT: 0) RETURNING SMALLINT

This function sets the value of parmValueDouble if the parmType variable = FLOAT. A non-zero return code indicate that parmType is not FLOAT.

getIntegerDefaultValue () RETURNING INTEGER

This function returns the value of the parmDefaultValueInteger variable.

getIntegerValue() RETURNING INTEGER

This function returns the value of the parmValueInteger variable.

setIntegerValue(value INTEGER: 0) RETURNING SMALLINT

This function sets the value of parmValueInteger if the parmType variable = INTEGER. A non-zero return code indicate that parmType is not INTEGER.

getStringDefaultValue () RETURNING CHAR(*)

This function returns the value of the parmDefaultValueString variable.

getStringValue() RETURNING CHAR(*)

This function returns the value of the parmValueString variable.

setStringValue(value CHAR(*): NULL) RETURNING SMALLINT

This function sets the value of parmValueString. if the parmType variable = STRING. A non-zero return code indicate that parmType is not STRING.

Return to Table of Contents.

ixActuateParm

Class Member Functions

Constructor

ixActuateParm(parmName CHAR(*): NULL,parmFileNumber SMALLINT: 0)

Accessing Parameter Properties

getName() returning CHAR(*)

getAlias() returning CHAR(*)

getRequired() RETURNING BOOLEAN

getHidden() RETURNING BOOLEAN

getHideText() RETURNING BOOLEAN

getAdHoc() RETURNING BOOLEAN

getParmType() RETURNING CHAR(*)

Accessing Parameter Values

getCurrencyDefaultValue () RETURNING MONEY

getCurrencyValue() RETURNING MONEY

setCurrencyValue(value MONEY: 0) RETURNING SMALLINT

getDateDefaultValue() RETURNING DATE

getDateValue() RETURNING DATE

setDateValue(value DATE: NULL) RETURNING SMALLINT

getDoubleDefaultValue() RETURNING FLOAT

getDoubleValue() RETURNING FLOAT

setDoubleValue(value FLOAT: 0) RETURNING SMALLINT

getIntegerDefaultValue () RETURNING INTEGER

getIntegerValue() RETURNING INTEGER

setIntegerValue(value INTEGER: 0) RETURNING SMALLINT

getStringDefaultValue () RETURNING CHAR(*)

getStringValue() RETURNING CHAR(*)

setStringValue(value CHAR(*): NULL) RETURNING SMALLINT

ixActuateParm(
parmName CHAR(*): NULL,
parmFileNumber SMALLINT: 0)