Click or drag to resize

DaoBaseFetchExcludedFieldsAsync Method (IEntityCollection, ITransaction, ExcludeIncludeFieldsList, CancellationToken)

Async variant of FetchExcludedFields(IEntityCollection, ITransaction, ExcludeIncludeFieldsList). Loads the data for the excluded fields specified in the list of excluded fields into all the entities in the entities collection passed in.

Namespace:  SD.LLBLGen.Pro.ORMSupportClasses
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.11.0.0 (5.11.23.1114)
Syntax
Copy
public Task FetchExcludedFieldsAsync(
	IEntityCollection entities,
	ITransaction containingTransaction,
	ExcludeIncludeFieldsList excludedIncludedFields,
	CancellationToken cancellationToken
)

Parameters

entities
Type: SD.LLBLGen.Pro.ORMSupportClassesIEntityCollection
The entities to load the excluded field data into. The entities have to be either of the same type or have to be in the same inheritance hierarchy as the entity which factory is set in the collection.
containingTransaction
Type: SD.LLBLGen.Pro.ORMSupportClassesITransaction
A containing transaction, if caller is added to a transaction, or null if not.
excludedIncludedFields
Type: SD.LLBLGen.Pro.ORMSupportClassesExcludeIncludeFieldsList
The excludedIncludedFields object as it is used when fetching the entitycollection. If you used the excludedIncludedFields object to fetch only the fields in that list (i.e. excludedIncludedFields.ExcludeContainedFields==false), the routine will fetch all other fields in the resultset for the entities in the collection excluding the fields in excludedIncludedFields.
cancellationToken
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: Task

Implements

IDaoFetchExcludedFieldsAsync(IEntityCollection, ITransaction, ExcludeIncludeFieldsList, CancellationToken)
Exceptions
ExceptionCondition
ORMGeneralOperationExceptionThe entity factory of the passed in entities collection is null.
Remarks
The field data is set like a normal field value set, so authorization is applied to it. This routine batches fetches to have at most 5*ParameterisedPrefetchPathThreshold of parameters per fetch. Keep in mind that most databases have a limit on the # of parameters per query.
See Also