Package io.camunda.client.impl.search.response

Class SearchResponsePageImpl

java.lang.Object

io.camunda.client.impl.search.response.SearchResponsePageImpl

All Implemented Interfaces:

SearchResponsePage

public class SearchResponsePageImpl
extends Object
implements SearchResponsePage

Constructor Summary

Constructors

Constructor	Description
SearchResponsePageImpl(Long totalItems, Boolean hasMoreTotalItems, String startCursor, String endCursor)
SearchResponsePageImpl(Long totalItems, String startCursor, String endCursor)

Method Summary

Modifier and Type	Method	Description
String	endCursor()	The cursor to the last item in the returned page.
Boolean	hasMoreTotalItems()	Whether the total items count exceeds the maximum limit in Elasticsearch (ES) or OpenSearch (OS).
String	startCursor()	The cursor to the first item in the returned page.
Long	totalItems()	Total number of items that matches the query

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SearchResponsePageImpl

public SearchResponsePageImpl(Long totalItems,
 String startCursor,
 String endCursor)

SearchResponsePageImpl

public SearchResponsePageImpl(Long totalItems,
 Boolean hasMoreTotalItems,
 String startCursor,
 String endCursor)

Method Details

totalItems

public Long totalItems()

Description copied from interface: SearchResponsePage

Total number of items that matches the query

Specified by:

totalItems in interface SearchResponsePage

hasMoreTotalItems

public Boolean hasMoreTotalItems()

Description copied from interface: SearchResponsePage

Whether the total items count exceeds the maximum limit in Elasticsearch (ES) or OpenSearch (OS).

In ES or OS, total items are often capped by a predefined configurable limit. If the result set is greater than or equal to this, this method returns true; otherwise, it returns false.

For RDBMS-backed searches, this is always false because there is no such limitation.

This helps clients understand when total item counts may be incomplete due to ES or OS limits.

Specified by:

hasMoreTotalItems in interface SearchResponsePage

Returns:

true if the total result count exceeds the cap in ES or OS; false otherwise.

startCursor

public String startCursor()

Description copied from interface: SearchResponsePage

The cursor to the first item in the returned page.

Specified by:

startCursor in interface SearchResponsePage

endCursor

public String endCursor()

Description copied from interface: SearchResponsePage

The cursor to the last item in the returned page.

Specified by:

endCursor in interface SearchResponsePage