Method ReadPaged

Namespace

Skyline.DataMiner.Utils.DOM.Extensions

Assembly

Skyline.DataMiner.Utils.DOM.dll

ReadPaged<T>(ICrudHelperComponent<T>, FilterElement<T>, long)

Reads data from the helper in a paged manner using a specified filter.

public static IEnumerable<IEnumerable<T>> ReadPaged<T>(this ICrudHelperComponent<T> helper, FilterElement<T> filter, long pageSize = 500) where T : DataType

Parameters

helper ICrudHelperComponent<T>

The helper component used to retrieve data.

filter FilterElement<T>

The filter criteria to apply.

pageSize long

The size of each page to retrieve.

Returns

IEnumerable<IEnumerable<T>>

An enumerable collection of data elements.

Type Parameters

T

The type of the data elements.

Exceptions

ArgumentNullException

Thrown when helper or filter is null.

ReadPaged<T>(ICrudHelperComponent<T>, IQuery<T>, long)

Reads items in a paged manner, based on the specified query and page size.

public static IEnumerable<IEnumerable<T>> ReadPaged<T>(this ICrudHelperComponent<T> helper, IQuery<T> query, long pageSize = 500) where T : DataType

Parameters

helper ICrudHelperComponent<T>

The helper component for CRUD operations.

query IQuery<T>

The query to apply to the data.

pageSize long

The number of items per page.

Returns

IEnumerable<IEnumerable<T>>

An enumerable collection of the queried data.

Type Parameters

T

The type of data to read.

Exceptions

ArgumentNullException

Thrown when helper or query is null.

ReadPaged<T, K>(ISelectHelperComponent<T, K>, FilterElement<T>, SelectedFields<T>, int)

Reads a selected subset of fields in a paged manner using a specified filter.

public static IEnumerable<IEnumerable<PartialObject<T, K>>> ReadPaged<T, K>(this ISelectHelperComponent<T, K> helper, FilterElement<T> filter, SelectedFields<T> fields, int pageSize = 500) where T : IManagerIdentifiableObject<K>, DataType where K : IEquatable<K>

Parameters

helper ISelectHelperComponent<T, K>

The helper component used to retrieve data.

filter FilterElement<T>

The filter criteria to apply.

fields SelectedFields<T>

The fields to retrieve.

pageSize int

The size of each page to retrieve.

Returns

IEnumerable<IEnumerable<PartialObject<T, K>>>

An enumerable collection of pages with partial objects.

Type Parameters

T

The type of the data elements.

K

The type of the identifier for the data elements.

Exceptions

ArgumentNullException

Thrown when helper, filter or fields is null.

ReadPaged<T, K>(ISelectHelperComponent<T, K>, IQuery<T>, SelectedFields<T>, int)

Reads a selected subset of fields in a paged manner using a specified query.

public static IEnumerable<IEnumerable<PartialObject<T, K>>> ReadPaged<T, K>(this ISelectHelperComponent<T, K> helper, IQuery<T> query, SelectedFields<T> fields, int pageSize = 500) where T : IManagerIdentifiableObject<K>, DataType where K : IEquatable<K>

Parameters

helper ISelectHelperComponent<T, K>

The helper component used to retrieve data.

query IQuery<T>

The query to apply to the data.

fields SelectedFields<T>

The fields to retrieve.

pageSize int

The size of each page to retrieve.

Returns

IEnumerable<IEnumerable<PartialObject<T, K>>>

An enumerable collection of pages with partial objects.

Type Parameters

T

The type of the data elements.

K

The type of the identifier for the data elements.

Exceptions

ArgumentNullException

Thrown when helper, query or fields is null.