DaoBasePerformGetMultiAction Method (ITransaction, IEntityCollection, Int64, ISortExpression, IPredicate, IRelationCollection, IPrefetchPath, ExcludeIncludeFieldsList, Int32, Int32) |
Retrieves in the passed in entity collection object all entity objects which match with the specified filter,
formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.
Namespace:
SD.LLBLGen.Pro.ORMSupportClasses
Assembly:
SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.4.0.0 (5.4.0)
Syntax protected bool PerformGetMultiAction(
ITransaction containingTransaction,
IEntityCollection collectionToFill,
long maxNumberOfItemsToReturn,
ISortExpression sortClauses,
IPredicate selectFilter,
IRelationCollection relations,
IPrefetchPath prefetchPathToUse,
ExcludeIncludeFieldsList excludedIncludedFields,
int pageNumber,
int pageSize
)
Protected Function PerformGetMultiAction (
containingTransaction As ITransaction,
collectionToFill As IEntityCollection,
maxNumberOfItemsToReturn As Long,
sortClauses As ISortExpression,
selectFilter As IPredicate,
relations As IRelationCollection,
prefetchPathToUse As IPrefetchPath,
excludedIncludedFields As ExcludeIncludeFieldsList,
pageNumber As Integer,
pageSize As Integer
) As Boolean
Parameters
- containingTransaction
- Type: SD.LLBLGen.Pro.ORMSupportClassesITransaction
A containing transaction, if caller is added to a transaction, or null if not. - collectionToFill
- Type: SD.LLBLGen.Pro.ORMSupportClassesIEntityCollection
Collection to fill with the entity objects retrieved - maxNumberOfItemsToReturn
- Type: SystemInt64
The maximum number of items to return with this retrieval query.
If the used Dynamic Query Engine supports it, 'TOP' is used to limit the amount of rows to return.
When set to 0, no limitations are specified. - sortClauses
- Type: SD.LLBLGen.Pro.ORMSupportClassesISortExpression
The order by specifications for the sorting of the resultset. When not specified, no sorting is applied. - selectFilter
- Type: SD.LLBLGen.Pro.ORMSupportClassesIPredicate
A predicate or predicate expression which should be used as filter for the entities to retrieve. - relations
- Type: SD.LLBLGen.Pro.ORMSupportClassesIRelationCollection
The set of relations to walk to construct to total query. - prefetchPathToUse
- Type: SD.LLBLGen.Pro.ORMSupportClassesIPrefetchPath
the PrefetchPath which defines the graph of objects to fetch. - excludedIncludedFields
- Type: SD.LLBLGen.Pro.ORMSupportClassesExcludeIncludeFieldsList
The list of IEntityField 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. - pageNumber
- Type: SystemInt32
The page number to retrieve. - pageSize
- Type: SystemInt32
The page size of the page to retrieve.
Return Value
Type:
BooleanSee Also