Click or drag to resize

SelfServicingExtensionMethods.GetSingleAsync<TEntity> Method (EntityQuery<TEntity>, ITransaction, CancellationToken)

Async variant of GetSingle<TEntity>(EntityQuery<TEntity>, ITransaction). Fetches the single entity of the set returned by the query and returns that entity. If there are no elements or more than 1 element, a NotSupportedException will be thrown.

Namespace:  SD.LLBLGen.Pro.QuerySpec.SelfServicing
Assembly:  SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.4.0.0 (5.4.0)
Syntax
Copy
public static Task<TEntity> GetSingleAsync<TEntity>(
	this EntityQuery<TEntity> query,
	ITransaction transactionToUse,
	CancellationToken cancellationToken
)
where TEntity : EntityBase, IEntity

Parameters

query
Type: SD.LLBLGen.Pro.QuerySpec.EntityQuery<TEntity>
The query.
transactionToUse
Type: SD.LLBLGen.Pro.ORMSupportClasses.ITransaction
The transaction to use.
cancellationToken
Type: System.Threading.CancellationToken
The cancellation token.

Type Parameters

TEntity
The type of the entity.

Return Value

Type: Task<TEntity>
the first entity in the resultset

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type EntityQuery<TEntity>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions
ExceptionCondition
ORMQueryConstructionExceptionThe ElementCreator in the query specified is either null or of the wrong type.
NotSupportedException
NotSupportedExceptionThrown if the resultset has 0 or 2 or more elements, as Single requires a single value in the resultset.
See Also