ArxEntityCollection

Definition

Namespace

ARX.SDK.Services

Package

ARX.SDK

public sealed class ArxEntityCollection

Constructor

• ArxEntityCollection()

  An empty collection.

• ArxEntityCollection(List<ArxEntity> list)

  A collection of these rows (the list itself, not a copy).

  Parameter	Type	Description
  list	List<ArxEntity>	The rows. The collection uses this list itself, not a copy.

Properties

• List<ArxEntity> Entities { get; }

  The rows, in the query's order.

• string? EntityName { get; set; }

  The row source the rows were read from.

• int TotalRecordCount { get; set; }

  Every row that matched, across all pages. Only set when the query asked for it (ReturnTotalRecordCount); without paging, the number of rows read.

• int CurrentPage { get; set; }

  The page these rows are (1 when the query isn't paged).

• int TotalPageCount { get; set; }

  How many pages there are; only set when the total was asked for.

• bool HasNextPage { get; set; }

  Whether another page follows. Always exact: ARX reads one row more than the page to know.

• string? PagingCookie { get; set; }

  Token paging: pass this to the next query's ArxPagingInfo.PagingCookie to read the next page. Null when no page follows, and always null from a provider without TokenPaging. On such a provider (PostgreSQL, SQL Server, MySQL) page by ArxPagingInfo.PageNumber instead: a loop that only passes this cookie on reads the first page again, because a null cookie means "the first page".

• ArxEntity this[int index] { get; set; }

  The row at this position.

Usage

Used in:

• Page through resultsRetrieveMultiple
• A security check around searchesRetrieveMultiple