IDataAccessAdapterFetchEntityCollection Method (IEntityCollection2, IRelationPredicateBucket, Int32, ISortExpression, IPrefetchPath2, ExcludeIncludeFieldsList) |
Fetches one or more entities which match the filter information in the filterBucket into the EntityCollection passed.
The entity collection object has to contain an entity factory object which will be the factory for the entity instances
to be fetched.
Namespace:
SD.LLBLGen.Pro.ORMSupportClasses
Assembly:
SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.9.0.0 (5.9.0)
Syntax void FetchEntityCollection(
IEntityCollection2 collectionToFill,
IRelationPredicateBucket filterBucket,
int maxNumberOfItemsToReturn,
ISortExpression sortClauses,
IPrefetchPath2 prefetchPath,
ExcludeIncludeFieldsList excludedIncludedFields
)
Sub FetchEntityCollection (
collectionToFill As IEntityCollection2,
filterBucket As IRelationPredicateBucket,
maxNumberOfItemsToReturn As Integer,
sortClauses As ISortExpression,
prefetchPath As IPrefetchPath2,
excludedIncludedFields As ExcludeIncludeFieldsList
)
Parameters
- collectionToFill
- Type: SD.LLBLGen.Pro.ORMSupportClassesIEntityCollection2
EntityCollection object containing an entity factory which has to be filled - filterBucket
- Type: SD.LLBLGen.Pro.ORMSupportClassesIRelationPredicateBucket
filter information for retrieving the entities. If null, all entities are returned of the type created by
the factory in the passed in EntityCollection instance. - maxNumberOfItemsToReturn
- Type: SystemInt32
The maximum amount of entities to return. If 0, all entities matching the filter are returned - sortClauses
- Type: SD.LLBLGen.Pro.ORMSupportClassesISortExpression
SortClause expression which is applied to the query executed, sorting the fetch result. - prefetchPath
- Type: SD.LLBLGen.Pro.ORMSupportClassesIPrefetchPath2
The prefetch path to use for this fetch, which will fetch all related entities defined by the path as well. - excludedIncludedFields
- Type: SD.LLBLGen.Pro.ORMSupportClassesExcludeIncludeFieldsList
The list of IEntityField2 objects which have to be excluded or included for the fetch.
If null or empty, all fields are fetched (default). If an instance of ExcludeIncludeFieldsList is passed in and its ExcludeContainedFields property
is set to false, the fields contained in excludedIncludedFields are kept in the query, the rest of the fields in the query are excluded.
Exceptions Exception | Condition |
---|
ArgumentException | If the passed in collectionToFill doesn't contain an entity factory. |
See Also