PageRange Object Members for Search Management in NetSuite

The PageRange object in the N/search module of NetSuite is essential for managing pagination when querying large datasets. It allows developers to define the page range for a paginated query, optimizing the process of retrieving search results efficiently.

What is the PageRange Object?

The search.PageRange object encapsulates two primary properties which are vital for pagination:

PageRange Properties

How to Use the PageRange Object

The PageRange object typically comes into play within the context of paginated searches. Use the properties of the PageRange to navigate between pages of results efficiently:

1. Creating a Search: When creating a search query, define pagination parameters to generate a PagedData object that can utilize PageRange to manage results.
2. Navigating Results: Utilize the index property to determine the current range’s position, allowing for easy access to previous or next pages of data.

Example Usage

Although the specific methods would depend on the overall search context, a typical usage scenario may look like this:

1var search = require('N/search');
2var paginatedSearch = search.create({
3    type: search.Type.TRANSACTION,
4    // Define any additional search options
5});
6var pagedData = paginatedSearch.runPaged({
7    pageSize: 100
8});
9 
10pagedData.pageRanges.forEach(function (pageRange) {
11    console.log('Page Index: ' + pageRange.index);
12    console.log('Label: ' + pageRange.compoundLabel);
13});

Important Consideration

The N/search module is only operational in authenticated client-side contexts. For further information, refer to SuiteAnswers regarding outbound HTTP in unauthenticated contexts.

Related Topics:

• Search Object Members
• PagedData Object Members

Understanding the PageRange object and its properties enhances your ability to handle large search datasets effectively, ensuring applications remain performant and user-friendly.

Key Takeaways

• The PageRange object is crucial for pagination in searches.
• Important properties include compoundLabel for user-friendly navigation and index for tracking current pagination.
• Use the PageRange within the context of PagedData to manage large datasets effectively.

Source: This article is based on Oracle's official NetSuite documentation.