FdcDataLoadRequest class

Query request sent by a dataset to an adapter.

The request carries effective filters, sorts, search criteria, paging bounds, and total-count requirements. Adapters should treat it as an immutable description of one load operation.

Constructors

FdcDataLoadRequest({List<FdcDataAdapterFilter> filters = const <FdcDataAdapterFilter>[], List<FdcDataAdapterSort> sorts = const <FdcDataAdapterSort>[], FdcDataSetSearchState search = const FdcDataSetSearchState(), int? offset, int? limit, bool includeFields = false, bool includeTotalCount = true, List<FdcFieldDef> fields = const <FdcFieldDef>[], FdcDataPageNavigation pageNavigation = FdcDataPageNavigation.random, Object? pageCursor, bool selectedKeysOnly = false, List<FdcDataRecordKey> selectedKeys = const <FdcDataRecordKey>[]})
Creates a FdcDataLoadRequest.
const

Properties

fields → List<FdcFieldDef>
Dataset schema fields available to adapters.
final
filters → List<FdcDataAdapterFilter>
Effective backend field predicates for this load.
final
hashCode → int
The hash code for this object.
no setterinherited
includeFields → bool
Requests optional schema metadata from adapters that can provide it.
final
includeTotalCount → bool
Whether adapters should compute and return FdcDataLoadResult.totalCount.
final
limit → int?
Maximum number of rows requested, or null for an unbounded load.
final
offset → int?
Zero-based row offset for paged loads.
final
pageCursor → Object?
Opaque adapter cursor for FdcDataPageNavigation.previous or FdcDataPageNavigation.next. The dataset stores and returns this value without interpreting it.
final
Optional navigation intent used by adapters that support cursor paging.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
Optional global-search criterion for this load.
final
selectedKeys → List<FdcDataRecordKey>
Dataset row keys that should be included by adapter-side selected-row filtering when selectedKeysOnly is true.
final
selectedKeysOnly → bool
Whether selectedKeys should be applied as an adapter-side include-only predicate. When true and selectedKeys is empty, adapters must return an empty result set.
final
sorts → List<FdcDataAdapterSort>
Effective backend ordering rules in priority order.
final

Methods

copyWith({List<FdcDataAdapterFilter>? filters, List<FdcDataAdapterSort>? sorts, FdcDataSetSearchState? search, Object? offset = _fdcUnsetLoadRequestValue, Object? limit = _fdcUnsetLoadRequestValue, bool? includeFields, bool? includeTotalCount, List<FdcFieldDef>? fields, FdcDataPageNavigation? pageNavigation, Object? pageCursor = _fdcUnsetLoadRequestValue, bool? selectedKeysOnly, List<FdcDataRecordKey>? selectedKeys}) → FdcDataLoadRequest
Creates a copy with selected values replaced.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
validatePagingContract() → void
Validates the adapter paging contract used by dataset and adapter load calls.

Operators

operator ==(Object other) → bool
The equality operator.
inherited