Insert Line Method in SuiteScript for Sublists

The insertLine method is a powerful function in SuiteScript that allows developers to insert a new line into a sublist of a record dynamically. This action automatically shifts existing lines downward, effectively updating the line count for the sublist.

Method Description

When you use the insertLine method, it obviates the need for manual adjustments in line numbering, as all subsequent lines are repositioned to accommodate the new entry. This is available in both dynamic and standard modes — for more on this, refer to SuiteScript 2.x Standard and Dynamic Modes.

Returns

The method returns a record.Record object that encapsulates the NetSuite record being manipulated.

Supported Script Types

The insertLine function is applicable in both client and server scripts. For detailed information on script types, see SuiteScript 2.x Script Types.

Governance

The insertLine method does not incur any governance restrictions, allowing for unrestricted use without impacting your script governance budget.

Module

This method is part of the N/record Module.

Parameters

The following table outlines the parameters accepted by the insertLine method:

Errors

It is crucial to handle potential errors when using this method:

• SSS_INVALID_SUBLIST_OPERATION: This error is raised if a required argument is invalid or if the sublist is not editable.
• SSS_MISSING_REQD_ARGUMENT: This error occurs when a required argument is either missing or undefined.

Syntax

Below is a code snippet illustrating the syntax for using the insertLine method. This example is not fully functional but serves to demonstrate the correct usage.

1// Add additional code
2...
3objRecord.insertLine({
4    sublistId: 'attendee',
5    line: 2,
6});
7objRecord.setCurrentSublistValue({
8    sublistId: 'attendee',
9    fieldId: 'attendee',
10    value: 838
11});
12objRecord.commitLine({
13    sublistId: 'attendee'
14});
15...
16// Add additional code

Related Topics

• record.Record
• N/record Module
• SuiteScript 2.x Modules
• For additional examples involving N/record methods, see N/record Module Script Samples.

Key Takeaways:

• The insertLine method adds lines to sublists effortlessly.
• It is applicable in both client and server scripts, with no governance limitations.
• It provides dynamic and standard mode compatibility, ensuring flexibility in scripting.
• Understanding the parameters and potential errors is critical for effective scripting.