Record functions (dynamic field access)

Home \| Table of Contents	Record functions (dynamic field access)
Prev	Functions Reference	Next

integer length( );
Returns the number of fields of a record the function is called on.

integer compare(reference record1, string field1, reference record2, string field2);
Compares two fields of given records. The fields are identified by their name. The function returns an integer value which is either:
1. < 0 ... field2 is greater than field1
2. > 0 ... field2 is lower than field1
3. 0 ... fields are equal

integer compare(reference record1, integer field1, reference record2, integer field2);
Compares two fields of given records. The fields are identified by their index (0 is the first field). The function returns an integer value which is either:
1. < 0 ... field2 is greater than field1
2. > 0 ... field2 is lower than field1
3. 0 ... fields are equal

boolean getBoolValue(reference record, integer field);
Returns the value of a boolean field. The field is identified by its index.

boolean getBoolValue(reference record, string field);
Returns the value of a boolean field. The field is identified by its name.

byte getByteValue(reference record, integer field);
Returns the value of a byte field. The field is identified by its index.

byte getByteValue(reference record, string field);
Returns the value of a byte field. The field is identified by its name.

date getDateValue(reference record, integer field);
Returns the value of a date field. The field is identified by its index.

date getDateValue(reference record, string field);
Returns the value of a date field. The field is identified by its name.

decimal getDecimalValue(reference record, integer field);
Returns the value of a decimal field. The field is identified by its index.

decimal getDecimalValue(reference record, string field);
Returns the value of a decimal field. The field is identified by its name.

integer getFieldIndex(reference record, string field);
Returns the index (zero-based) of a field which is identified by its name. If the field name is not found in the record, the function returns -1.

string getFieldLabel(reference record, integer field);
Returns the label of a field which is identified by its index. Please note a label is not a field's name, see Field Name vs. Label vs. Description.

string getFieldName(record argRecord, integer index);

The getFieldName(record, integer) function accepts two arguments: record and integer. The function takes them and returns the name of the field with the specified index. Fields are numbered starting from 0.

Important

	Important
The `argRecord` may have any of the following forms: `$<port number>.` E.g., `$0.` `$<metadata name>.` E.g., `$customers.` `<record variable name>[.]` E.g., `Customers` or `Customers.` (both cases, if `Customers` was declared as record in CTL.) `lookup(<lookup table name>).get(<key value>)[.]` E.g., `lookup(Comp).get("JohnSmith")` or `lookup(Comp).get("JohnSmith").` `lookup(<lookup table name>).next()[.]` E.g., `lookup(Comp).next()` or `lookup(Comp).next().`

The argRecord may have any of the following forms:

$<port number>.*
E.g., $0.*
$<metadata name>.*
E.g., $customers.*
<record variable name>[.*]
E.g., Customers or Customers.* (both cases, if Customers was declared as record in CTL.)
lookup(<lookup table name>).get(<key value>)[.*]
E.g., lookup(Comp).get("JohnSmith") or lookup(Comp).get("JohnSmith").*
lookup(<lookup table name>).next()[.*]
E.g., lookup(Comp).next() or lookup(Comp).next().*

string getFieldType(record argRecord, integer index);
The getFieldType(record, integer) function accepts two arguments: record and integer. The function takes them and returns the type of the field with the specified index. Fields are numbered starting from 0.
Important
Records as arguments look like the records for the getFieldName() function. See above.

	Important
Records as arguments look like the records for the `getFieldName()` function. See above.

integer getIntegerValue(reference record, integer field);
Returns the value of an integer field. The field is identified by its index.

integer getIntegerValue(reference record, string field);
Returns the value of an integer field. The field is identified by its name.

long getLongValue(reference record, integer field);
Returns the value of a long field. The field is identified by its index.

long getLongValue(reference record, string field);
Returns the value of a long field. The field is identified by its name.

number getNumValue(reference record, integer field);
Returns the value of a number field. The field is identified by its index.

number getNumValue(reference record, string field);
Returns the value of a number field. The field is identified by its name.

string getStringValue(reference record, integer field);
Returns the value of a string field. The field is identified by its index.

string getStringValue(reference record, string field);
Returns the value of a string field. The field is identified by its name.

string getValueAsString(reference record, string field);
Attempts to return the value of a field (no matter its type) as a common string. The field is identified by its name.

string getValueAsString(reference record, integer field);
Attempts to return the value of a field (no matter its type) as a common string. The field is identified by its index.

boolean isNull(reference record, string field);
Checks whether a given field is null. The field is identified by its name.

boolean isNull(reference record, integer field);
Checks whether a given field is null. The field is identified by its index.

void setBoolValue(reference record, integer field, boolean value);
Sets a boolean value to a field. The field is identified by its index.

void setBoolValue(reference record, string field, boolean value);
Sets a boolean value to a field. The field is identified by its name.

void setByteValue(reference record, integer field, byte value);
Sets a byte value to a field. The field is identified by its index.

void setByteValue(reference record, string field, byte field);
Sets a byte value to a field. The field is identified by its name.

void setDateValue(reference record, integer field, date value);
Sets a date value to a field. The field is identified by its index.

void setDateValue(reference record, string field, date value);
Sets a date value to a field. The field is identified by its name.

void setDecimalValue(reference record, integer field, decimal value);
Sets a decimal value to a field. The field is identified by its index.

void setDecimalValue(reference record, string field, decimal value);
Sets a decimal value to a field. The field is identified by its name.

void setIntValue(reference record, integer field, integer value);
Sets an integer value to a field. The field is identified by its index.

void setIntValue(reference record, string field, integer value);
Sets an integer value to a field. The field is identified by its name.

void setLongValue(reference record, integer field, long value);
Sets a long value to a field. The field is identified by its index.

void setLongValue(reference record, string field, long value);
Sets a long value to a field. The field is identified by its name.

void setNumValue(reference record, integer field, number value);
Sets a number value to a field. The field is identified by its index.

void setNumValue(reference record, string field, number value);
Sets a number value to a field. The field is identified by its name.

void setStringValue(reference record, integer field, string value);
Sets a string value to a field. The field is identified by its index.

void setStringValue(reference record, string field, string value);
Sets a string value to a field. The field is identified by its name.

Prev	Up	Next
Container Functions	Home \| Table of Contents	Miscellaneous Functions