PrefetchPathAdd Method (IPrefetchPathElement, Int32, IPredicateExpression, IRelationCollection, ISortExpression, ExcludeIncludeFieldsList) |
Adds the specified element to the path.
Namespace:
SD.LLBLGen.Pro.ORMSupportClasses
Assembly:
SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.8.0.0 (5.8.21.0111)
Syntax public virtual IPrefetchPathElement Add(
IPrefetchPathElement elementToAdd,
int maxAmountOfItemsToReturn,
IPredicateExpression additionalFilter,
IRelationCollection additionalFilterRelations,
ISortExpression additionalSorter,
ExcludeIncludeFieldsList excludedIncludedFields
)
Public Overridable Function Add (
elementToAdd As IPrefetchPathElement,
maxAmountOfItemsToReturn As Integer,
additionalFilter As IPredicateExpression,
additionalFilterRelations As IRelationCollection,
additionalSorter As ISortExpression,
excludedIncludedFields As ExcludeIncludeFieldsList
) As IPrefetchPathElement
Parameters
- elementToAdd
- Type: SD.LLBLGen.Pro.ORMSupportClassesIPrefetchPathElement
The PrefetchPathElement to add - maxAmountOfItemsToReturn
- Type: SystemInt32
Maximum amount of items to fetch of the set of entities specified by the element. - additionalFilter
- Type: SD.LLBLGen.Pro.ORMSupportClassesIPredicateExpression
Additional predicate expression to be added to the filter already in the PrefetchPathElement - additionalFilterRelations
- Type: SD.LLBLGen.Pro.ORMSupportClassesIRelationCollection
Additional relations to be added to the relationcollection already in the PrefetchPathElement - additionalSorter
- Type: SD.LLBLGen.Pro.ORMSupportClassesISortExpression
Additional sort clauses to be added added to the sortexpression already in the PrefetchPathElement - 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.
Return Value
Type:
IPrefetchPathElementthe element added, so chaining of commands is possible
Implements
IPrefetchPathAdd(IPrefetchPathElement, Int32, IPredicateExpression, IRelationCollection, ISortExpression, ExcludeIncludeFieldsList)Exceptions Exception | Condition |
---|
ArgumentException | When the elementToAdd is a node definition which is already added to this path. |
See Also