Click or drag to resize

EntityBase.DeleteAsync Method (IPredicate, CancellationToken)

Async variant of Delete(IPredicate). Deletes the Entity from the persistent storage. This method succeeds also when the Entity is not present.

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
Copy
public virtual Task<bool> DeleteAsync(
	IPredicate deleteRestriction,
	CancellationToken cancellationToken
)

Parameters

deleteRestriction
Type: SD.LLBLGen.Pro.ORMSupportClasses.IPredicate
Predicate expression, meant for concurrency checks in a delete query. Overrules the predicate returned by a set ConcurrencyPredicateFactory object.
cancellationToken
Type: System.Threading.CancellationToken
The cancellation token.

Return Value

Type: Task<Boolean>
true if Delete succeeded, false otherwise

Implements

IEntity.DeleteAsync(IPredicate, CancellationToken)
Exceptions
ExceptionCondition
ORMConcurrencyExceptionThe delete action of an entity failed, probably due to the set delete restriction provided. The entity which failed is enclosed.
ORMQueryExecutionExceptionWhen an exception is caught during the delete process. The caught exception is set as the inner exception. Encapsulation of database-related exceptions is necessary since these exceptions do not have a common exception framework implemented.
See Also