Class: nlobjRecord

nlobjRecord

new nlobjRecord() → {nlobjRecord}

Return a new instance of nlobjRecord used for accessing and manipulating record objects.
Since:
  • 2008.2
Source:
Returns:
Type
nlobjRecord

Methods

commitLineItem(group) → {void}

Commit the current line in a sublist.
Parameters:
Name Type Description
group string sublist name
Since:
  • 2009.2
Source:
Returns:
Type
void

findLineItemMatrixValue(group, fldnam, column, value) → {int}

Return line number for 1st occurence of field value in a sublist column.
Parameters:
Name Type Description
group string sublist name
fldnam string sublist field name
column int matrix column index (1-based)
value string matrix field value
Since:
  • 2009.2
Source:
Returns:
Type
int

findLineItemValue(group, fldnam, value) → {int}

Return line number for 1st occurence of field value in a sublist column.
Parameters:
Name Type Description
group string sublist name
fldnam string sublist field name
value string sublist field value
Since:
  • 2009.2
Source:
Returns:
Type
int

getAllFields() → {string[]}

Return an Array of all field names on the record.
Since:
  • 2008.1
Source:
Returns:
Type
string[]

getAllLineItemFields(group) → {string[]}

Return an Array of all field names on a record for a particular sublist.
Parameters:
Name Type Description
group string sublist name
Since:
  • 2008.2
Source:
Returns:
Type
string[]

getCurrentLineItemMatrixValue(group, name, column) → {string}

Return the current value of a sublist matrix field.
Parameters:
Name Type Description
group string matrix sublist name
name string matrix field name
column int matrix field column index (1-based)
Since:
  • 2009.2
Source:
Returns:
Type
string

getCurrentLineItemText(group, name) → {string}

Return the current display value of a sublist field.
Parameters:
Name Type Description
group string sublist name
name string sublist field name
Since:
  • 2009.2
Source:
Returns:
Type
string

getCurrentLineItemValue(group, name) → {string}

Return the current value of a sublist field.
Parameters:
Name Type Description
group string sublist name
name string sublist field name
Since:
  • 2009.2
Source:
Returns:
Type
string

getField(fldnam) → {nlobjField}

Return field metadata for field.
Parameters:
Name Type Description
fldnam string field name
Since:
  • 2009.1
Source:
Returns:
Type
nlobjField

getFieldText(name) → {string}

Return the display value for a select field.
Parameters:
Name Type Description
name string field name
Since:
  • 2008.2
Source:
Returns:
Type
string

getFieldTexts(name) → {string[]}

Return the selected display values of a multi-select field as an Array.
Parameters:
Name Type Description
name string field name
Since:
  • 2008.2
Source:
Returns:
Type
string[]

getFieldValue(name) → {string}

Return the value of a field.
Parameters:
Name Type Description
name string field name
Since:
  • 2008.1
Source:
Returns:
Type
string

getFieldValues(name) → {string[]}

Return the selected values of a multi-select field as an Array.
Parameters:
Name Type Description
name string field name
Since:
  • 2008.1
Source:
Returns:
Type
string[]

getId() → {int}

Return the internalId of the record or NULL for new records.
Since:
  • 2008.1
Source:
Returns:
Return the integer value of the record ID.
Type
int

getLineItemCount(group)

Return the number of lines in a sublist.
Parameters:
Name Type Description
group string sublist name
Since:
  • 2009.2
Source:

getLineItemField(type, fldnam, linenum) → {nlobjField}

Return metadata for sublist field.
Parameters:
Name Type Argument Description
type string sublist name
fldnam string sublist field name
linenum int <optional>
line number (1-based). If empty, the current sublist field is returned. only settable for sublists of type list
Since:
  • 2009.2
Source:
Returns:
Type
nlobjField

getLineItemMatrixField(type, fldnam, linenum, linenum) → {nlobjField}

Return metadata for sublist field.
Parameters:
Name Type Description
type string matrix sublist name
fldnam string matrix field name
linenum int line number
linenum column matrix column (1-based)
Since:
  • 2009.2
Source:
Returns:
Type
nlobjField

getLineItemText(group, name, line) → {string}

Return the text value of a sublist field.
Parameters:
Name Type Description
group string sublist name
name string sublist field name
line int line number (1-based)
Since:
  • 2008.2
Source:
Returns:
Type
string

getLineItemValue(group, name, line)

Return the value of a sublist field.
Parameters:
Name Type Description
group string sublist name
name string sublist field name
line int line number (1-based)
Since:
  • 2008.1
Source:

getMatrixCount(group, name) → {int}

Return the number of columns for a matrix field.
Parameters:
Name Type Description
group string matrix sublist name
name string matrix field name
Since:
  • 2009.2
Source:
Returns:
Type
int

getMatrixField(type, fldnam, linenum) → {nlobjField}

Return field metadata for field.
Parameters:
Name Type Description
type string matrix sublist name
fldnam string matrix field name
linenum column matrix column (1-based)
Since:
  • 2009.2
Source:
Returns:
Type
nlobjField

getMatrixValue(type, name, column) → {string}

Get the value of a matrix header field.
Parameters:
Name Type Description
type string matrix sublist name
name string matrix field name
column int matrix column index (1-based)
Since:
  • 2009.2
Source:
Returns:
Type
string

getRecordType() → {string}

Return the recordType corresponding to this record.
Since:
  • 2008.1
Source:
Returns:
The string value of the record name internal ID
Type
string

getSubList(type) → {nlobjSubList}

Return sublist metadata for sublist.
Parameters:
Name Type Description
type string sublist name
Since:
  • 2009.2
Source:
Returns:
Type
nlobjSubList

insertLineItem(group, line)

Insert a new line into a sublist.
Parameters:
Name Type Argument Description
group string sublist name
line int <optional>
line index at which to insert line
Since:
  • 2009.2
Source:

removeLineItem(group, line)

Remove an existing line from a sublist.
Parameters:
Name Type Argument Description
group string sublist name
line int <optional>
line number to remove
Since:
  • 2009.2
Source:

selectLineItem(group, line) → {void}

Select an existing line in a sublist.
Parameters:
Name Type Description
group string sublist name
line int line number to select
Since:
  • 2009.2
Source:
Returns:
Type
void

selectNewLineItem(group) → {void}

Insert and select a new line in a sublist.
Parameters:
Name Type Description
group string sublist name
Since:
  • 2009.2
Source:
Returns:
Type
void

setCurrentLineItemMatrixValue(group, name, column, value) → {void}

Set the current value of a sublist matrix field.
Parameters:
Name Type Description
group string matrix sublist name
name string matrix field name
column int matrix field column index (1-based)
value string matrix field value
Since:
  • 2009.2
Source:
Returns:
Type
void

setCurrentLineItemValue(group, name, value) → {void}

Set the current value of a sublist field.
Parameters:
Name Type Description
group string sublist name
name string sublist field name
value string sublist field value
Since:
  • 2009.2
Source:
Returns:
Type
void

setFieldText(name, text) → {void}

Set the value (via display value) of a select field.
Parameters:
Name Type Description
name string field name
text string field display value
Since:
  • 2008.2
Source:
Returns:
Type
void

setFieldTexts(name, texts) → {void}

Set the values (via display values) of a multi-select field.
Parameters:
Name Type Description
name string field name
texts string[] array of field display values
Since:
  • 2008.2
Source:
Returns:
Type
void

setFieldValue(name, value) → {void}

Set the value of a field.
Parameters:
Name Type Description
name string field name
value string field value
Since:
  • 2008.1
Source:
Returns:
Type
void

setFieldValues(name, values)

Set the values of a multi-select field.
Parameters:
Name Type Description
name string field name
values string[] string array containing field values
Since:
  • 2008.1
Source:

setLineItemValue(group, name, line, value)

Set the value of a sublist field.
Parameters:
Name Type Description
group string sublist name
name string sublist field name
line int line number (1-based)
value string sublist field value
Since:
  • 2008.1
Source:

setMatrixValue(type, name, column, value) → {void}

Set the value of a matrix header field.
Parameters:
Name Type Description
type string matrix sublist name
name string matrix field name
column int matrix column index (1-based)
value string field value
Since:
  • 2009.2
Source:
Returns:
Type
void