Page Object Members for Query in SuiteScript

The Page Object Members in SuiteScript allow developers to manage query results effectively through a paginated interface. This feature is integral for optimizing data retrieval and rendering in NetSuite solutions.

What Are Page Object Members?

Page Object Members are properties available for a query.Page object, designed to facilitate efficient handling of paged query results. Each member serves a specific purpose, providing access to different aspects of the data contained within the page.

Page Object Members Overview

The following table summarizes the available members for a Page object:

How to Use Page Object Members

Using Page Object Members can standardize and streamline data retrieval in SuiteScript.

Example Code Snippet

Here’s a sample syntax demonstrating how to utilize Page Object Members within a SuiteScript context:

1// Example of working with Page Object Members
2var myCustomerQuery = query.create({
3    type: query.Type.CUSTOMER
4});
5myCustomerQuery.columns = [
6    myCustomerQuery.createColumn({ fieldId: 'entityid' }),
7    myCustomerQuery.createColumn({ fieldId: 'firstname' }),
8    myCustomerQuery.createColumn({ fieldId: 'email' })
9];
10var myPagedResults = myCustomerQuery.runPaged({ pageSize: 10 });
11 
12// Fetching results using an iterator
13var iterator = myPagedResults.iterator();
14iterator.each(function(resultPage) {
15    var currentPage = resultPage.value;
16    log.debug(currentPage.pageRange.size);
17    return true;
18});
19 
20// Alternatively, using a loop
21for (var i = 0; i < myPagedResults.pageRanges.length; i++) {
22    var currentPage = myPagedResults.fetch(i);
23    log.debug(currentPage.pageRange.size);
24}

Who This Affects

• Developers: Working with SuiteScript for data retrieval.
• Administrators: Implementing and maintaining data management scripts.

Key Takeaways

• Page Object Members represent a structured way to access paged query results in SuiteScript.
• Each member plays a crucial role in manipulating and retrieving query results efficiently.
• Understanding these members can greatly enhance script performance and data handling capabilities.