commitLine Method for Sublist Operations in SuiteScript

The commitLine method is used in SuiteScript to finalize edits to a line within a sublist. This is critical for ensuring that data entered on sublists is correctly processed and saved.

Method Description

The commitLine method commits the currently selected line on a sublist, reflecting user inputs or changes in the user interface directly onto the underlying data object.

Returns

This method returns the currentRecord.CurrentRecord object that initiated the call. This allows for further manipulations or queries on the record if needed after the line commitment.

Supported Script Types

• Client scripts are the only supported script type for this method. For additional details on script types, you can refer to the document on SuiteScript 2.x Script Types.

Governance

• There is no governance associated with this method, making it straightforward to use without restrictions on usage limits.

Module

This method belongs to the N/currentRecord module, which encapsulates the record currently being manipulated.

Parameters

Required Parameters

Optional Parameters

Error Codes

Common Error Codes

• SSS_INVALID_SUBLIST_OPERATION: Triggered if a required argument is invalid or if the sublist is not editable.
• SSS_MISSING_REQD_ARGUMENT: Triggered when a required argument is missing or undefined.

Syntax Example

The following example demonstrates how to use the commitLine method, although it is important to note that this code sample is for reference and not a complete script.

1//Add additional code 
2...
3objRecord.commitLine({
4    sublistId: 'item'
5});
6... 
7//Add additional code

Related Topics

• N/currentRecord Module
• SuiteScript 2.x Modules

Key Takeaways

• The commitLine method commits changes on a sublist line, essential in client scripts.
• No governance limitations allow for flexibility in usage.
• Understand the required and optional parameters to use this method effectively.