APIRepository<O extends Object> class abstract

A entity repository API.

Mixed-in types

Constructors

APIRepository({EntityRepository<O>? entityRepository, EntityRepositoryProvider? provider, Type? type})

Properties

cyclicDependencies → List<Initializable>
The dependencies of the current (or last) initialization attempt that were not waited for: they were (transitively) waiting for this instance (a cycle), so they may still be initializing when initialize runs or when this instance is initialized.
no setterinherited
entityRepository → EntityRepository<O>
final
hashCode → int
The hash code for this object.
no setterinherited
initializationStatus → InitializationStatus
Returns the current InitializationStatus.
no setterinherited
isAsyncInitialization → bool
Returns true if this instance initialization was asynchronous.
no setterinherited
isInitialized → bool
Returns true if this instance is already initialized.
no setterinherited
isInitializing → bool
Returns true if this instance is in the middle of the initialization process.
no setterinherited
onDelete → EventStream<O>
no setter
onStore → EventStream<O>
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

checkInitialized({bool allowInProgress = true}) → void
Checks if this instance is initialized, initializing it if possible.
inherited
configure() → void
count({EntityMatcher<O>? matcher, Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, Transaction? transaction}) → FutureOr<int>
countByQuery(String query, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, Transaction? transaction}) → FutureOr<int>
delete(EntityMatcher<O> matcher, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, Transaction? transaction}) → FutureOr<Iterable<O>>
deleteByID(dynamic id, {Transaction? transaction}) → FutureOr<O?>
deleteByQuery(String query, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, Transaction? transaction}) → FutureOr<Iterable<O>>
deleteEntity(O o, {Transaction? transaction}) → FutureOr<O?>
deleteEntityCascade(O o, {Transaction? transaction}) → FutureOr<Iterable>
doInitialization({Initializable? parent}) → FutureOr<InitializationResult>
Initialize this instance if is not initialized yet. Same as ensureInitialized.
inherited
ensureConfigured() → void
ensureInitialized({Initializable? parent}) → FutureOr<InitializationResult>
Ensures that this instance is initialized.
inherited
ensureInitializedAsync({Initializable? parent}) → FutureOr<InitializationResult>
Ensures that this instance is initialized. If is not initialized yet it will force an asynchronous initialization and return a Future.
inherited
executeInitialized<R>(ExecuteInitializedCallback<R> callback, {Initializable? parent}) → FutureOr<R>
Executes the callback ensuring that this instance was initialized.
inherited
existIDs<I extends Object>(List<I?> ids, {Transaction? transaction}) → FutureOr<Iterable<I>>
existsID(dynamic id, {Transaction? transaction}) → FutureOr<bool>
initialize() → FutureOr<InitializationResult>
Initialization implementation. Do not call it directly, use doInitialization.
override
initializeDependencies() → FutureOr<List<Initializable>>
Return a List of Initializable instances that need to be initialized BEFORE initialize this instance.
inherited
length() → FutureOr<int>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paginate(EntityMatcher<O> matcher, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, required int limit, bool? orderByID, OrderDirection? orderDirection, Transaction? transaction, EntityResolutionRules? resolutionRules, EntityPaginationListener<O>? onEvent}) → EntityPagination<O>
Returns an EntityPagination over this select, loading nothing yet: pages are fetched only when asked for. See EntityPagination.
paginateAll({required int limit, bool? orderByID, OrderDirection? orderDirection, Transaction? transaction, EntityResolutionRules? resolutionRules, EntityPaginationListener<O>? onEvent}) → EntityPagination<O>
Returns an EntityPagination over this select, loading nothing yet: pages are fetched only when asked for. See EntityPagination.
paginateByQuery(String query, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, required int limit, bool? orderByID, OrderDirection? orderDirection, Transaction? transaction, EntityResolutionRules? resolutionRules, EntityPaginationListener<O>? onEvent}) → EntityPagination<O>
Returns an EntityPagination over this select, loading nothing yet: pages are fetched only when asked for. See EntityPagination.
select(EntityMatcher<O> matcher, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, int? limit, int? offset, int? page, bool? orderByID, OrderDirection? orderDirection, Transaction? transaction, EntityResolutionRules? resolutionRules}) → FutureOr<Iterable<O>>
Ordering and pagination:
selectAll({int? limit, int? offset, int? page, bool? orderByID, OrderDirection? orderDirection, Transaction? transaction, EntityResolutionRules? resolutionRules}) → FutureOr<Iterable<O>>
Ordering and pagination:
selectByID(dynamic id, {Transaction? transaction, EntityResolutionRules? resolutionRules}) → FutureOr<O?>
selectByIDs(List ids, {Transaction? transaction, EntityResolutionRules? resolutionRules}) → FutureOr<List<O?>>
selectByQuery(String query, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, int? limit, int? offset, int? page, bool? orderByID, OrderDirection? orderDirection, Transaction? transaction, EntityResolutionRules? resolutionRules}) → FutureOr<Iterable<O>>
Ordering and pagination:
selectFirstByQuery(String query, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, int? offset, int? page, bool? orderByID, OrderDirection? orderDirection, Transaction? transaction, EntityResolutionRules? resolutionRules}) → FutureOr<O?>
Ordering and pagination:
selectIDsBy<I extends Object>(EntityMatcher<O> matcher, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, int? limit, int? offset, int? page, bool? orderByID, OrderDirection? orderDirection, Transaction? transaction}) → FutureOr<Iterable<I>>
Ordering and pagination:
selectIDsByQuery<I extends Object>(String query, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, int? limit, int? offset, int? page, bool? orderByID, OrderDirection? orderDirection, Transaction? transaction}) → FutureOr<Iterable<I>>
Ordering and pagination:
store(O o, {Transaction? transaction}) → FutureOr
storeAll(Iterable<O> os, {Transaction? transaction}) → FutureOr<List>
storeAllFromJson(Iterable<Map<String, dynamic>> entitiesJson, {Transaction? transaction, EntityResolutionRules? resolutionRules}) → FutureOr<List<O>>
storeFromJson(Map<String, dynamic> json, {Transaction? transaction, EntityResolutionRules? resolutionRules}) → FutureOr<O>
toString() → String
A string representation of this object.
inherited
tryDeleteByID(dynamic id, {Transaction? transaction}) → FutureOr<O?>
tryDeleteEntity(O o, {Transaction? transaction}) → FutureOr<O?>

Operators

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

Static Methods

resolveEntityRepository<O extends Object>({EntityRepository<O>? entityRepository, EntityRepositoryProvider? provider, Type? type, bool required = false}) → EntityRepository<O>?
Resolves a EntityRepository.