Click or drag to resize

PrefetchPath2Add Method (IPrefetchPathElement2, Int32, IPredicateExpression, IRelationCollection, ISortExpression, IEntityFactory2, 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.5.0.0 (5.5.18.1019)
Syntax
Copy
public virtual IPrefetchPathElement2 Add(
	IPrefetchPathElement2 elementToAdd,
	int maxAmountOfItemsToReturn,
	IPredicateExpression additionalFilter,
	IRelationCollection additionalFilterRelations,
	ISortExpression additionalSorter,
	IEntityFactory2 entityFactoryToUse,
	ExcludeIncludeFieldsList excludedIncludedFields
)

Parameters

elementToAdd
Type: SD.LLBLGen.Pro.ORMSupportClassesIPrefetchPathElement2
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
entityFactoryToUse
Type: SD.LLBLGen.Pro.ORMSupportClassesIEntityFactory2
The entity factory to use to produce the related entities.
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.

Return Value

Type: IPrefetchPathElement2
the element added, so chaining of commands is possible

Implements

IPrefetchPath2Add(IPrefetchPathElement2, Int32, IPredicateExpression, IRelationCollection, ISortExpression, IEntityFactory2, ExcludeIncludeFieldsList)
Exceptions
ExceptionCondition
ArgumentExceptionWhen the elementToAdd is a node definition which is already added to this path.
See Also