PrefetchPath Class

PrefetchPath Class

PrefetchPath class, which specifies a prefetch path to fetch related entities during a fetch. SelfServicing specific.

Inheritance Hierarchy

SystemObject
System.CollectionsCollectionBase
SD.LLBLGen.Pro.ORMSupportClassesPrefetchPath

Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.2.0.0 (5.2.17.0403)

Syntax

Copy

[SerializableAttribute]
public class PrefetchPath : CollectionBase, 
	IPrefetchPath, IPrefetchPathCore, IEnumerable

<SerializableAttribute>
Public Class PrefetchPath
	Inherits CollectionBase
	Implements IPrefetchPath, IPrefetchPathCore, IEnumerable

The PrefetchPath type exposes the following members.

Constructors

	Name	Description
	PrefetchPath(Enum)	CTor
	PrefetchPath(Int32)	CTor

Top

Properties

	Name	Description
	Capacity	Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.)
	Count	Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.)
	InnerList	Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
	Item	Indexer in the prefetch path
	List	Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
	RootEntityType	The EntityType enum value for the entity which is the root type of this path.

Top

Methods

	Name	Description
	Add(IPrefetchPathElement)	Adds the specified element to the path.
	Add(IPrefetchPathElement, ExcludeIncludeFieldsList)	Adds the specified element to the path.
	Add(IPrefetchPathElement, Int32)	Adds the specified element to the path.
	Add(IPrefetchPathElement, Int32, IPredicateExpression)	Adds the specified element to the path.
	Add(IPrefetchPathElement, Int32, IPredicateExpression, IRelationCollection)	Adds the specified element to the path.
	Add(IPrefetchPathElement, Int32, IPredicateExpression, IRelationCollection, ISortExpression)	Adds the specified element to the path.
	Add(IPrefetchPathElement, Int32, IPredicateExpression, IRelationCollection, ISortExpression, ExcludeIncludeFieldsList)	Adds the specified element to the path.
	Clear	Removes all objects from the CollectionBase instance. This method cannot be overridden. (Inherited from CollectionBase.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnClear	Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.)
	OnClearComplete	Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.)
	OnInsert	Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
	OnInsertComplete	Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
	OnRemove	Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
	OnRemoveComplete	Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
	OnSet	Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
	OnSetComplete	Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
	OnValidate	Performs additional custom processes when validating a value. (Inherited from CollectionBase.)
	RemoveAt	Removes the element at the specified index of the CollectionBase instance. This method is not overridable. (Inherited from CollectionBase.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	UseRootMaxLimitAndSorterInPrefetchPathSubQueriesDefault	The default value for the 'UseRootMaxLimitAndSorterInPrefetchPathSubQueries' flag. This is also a configurable setting in the config file: add a line to the config file's appSettings section: useRootMaxLimitAndSorterInPrefetchPathSubQueries and specify a value of true or false. Default is false.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableGetEnumerator	Returns an enumerator that iterates through the CollectionBase instance.
	IListAdd	Adds an object to the end of the CollectionBase. (Inherited from CollectionBase.)
	IListContains	Determines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.)
	ICollectionCopyTo	Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase.)
	IListIndexOf	Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase.)
	IListInsert	Inserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.)
	IPrefetchPathCoreItem	Indexer in the prefetch path
	IListIsFixedSize	Gets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.)
	IListIsReadOnly	Gets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.)
	ICollectionIsSynchronized	Gets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.)
	IListItem	Gets or sets the element at the specified index. (Inherited from CollectionBase.)
	IListRemove	Removes the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.)
	ICollectionSyncRoot	Gets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase.)

Top

Reference

SD.LLBLGen.Pro.ORMSupportClasses Namespace