IUpdateEntry IUpdateEntry Interface

Definition

The information passed to a database provider to save changes to an entity to the database.

This interface is typically used by database providers (and other extensions). It is generally not used in application code.

public interface IUpdateEntry
Public Interface IUpdateEntry

Properties

EntityState EntityState

The state of the entity to be saved.

EntityState EntityState { get; }
ReadOnly Property EntityState As EntityState

EntityType EntityType

The type of entity to be saved to the database.

IEntityType EntityType { get; }
ReadOnly Property EntityType As IEntityType

Methods

GetCurrentValue(IPropertyBase) GetCurrentValue(IPropertyBase)

Gets the value assigned to the property.

object GetCurrentValue(IPropertyBase propertyBase)
Function GetCurrentValue(propertyBase As IPropertyBase) As Object
Parameters
propertyBase
IPropertyBase IPropertyBase

The property to get the value for.

Returns
System.Object System.Object

The value for the property.

GetCurrentValue(IPropertyBase) GetCurrentValue(Of TProperty)(IPropertyBase)

Gets the value assigned to the property.

TProperty GetCurrentValue<TProperty>(IPropertyBase propertyBase)
Function GetCurrentValue(Of TProperty)(propertyBase As IPropertyBase) As TProperty
Type Parameters
TProperty

The type of the property.

Parameters
propertyBase
IPropertyBase IPropertyBase

The property to get the value for.

Returns
TProperty TProperty

The value for the property.

GetOriginalValue(IPropertyBase) GetOriginalValue(IPropertyBase)

Gets the value assigned to the property when it was retrieved from the database.

object GetOriginalValue(IPropertyBase propertyBase)
Function GetOriginalValue(propertyBase As IPropertyBase) As Object
Parameters
propertyBase
IPropertyBase IPropertyBase

The property to get the value for.

Returns
System.Object System.Object

The value for the property.

GetOriginalValue(IProperty) GetOriginalValue(Of TProperty)(IProperty)

Gets the value assigned to the property when it was retrieved from the database.

TProperty GetOriginalValue<TProperty>(IProperty property)
Function GetOriginalValue(Of TProperty)(property As IProperty) As TProperty
Type Parameters
TProperty

The type of the property.

Parameters
property
IProperty IProperty

The property to get the value for.

Returns
TProperty TProperty

The value for the property.

HasTemporaryValue(IProperty) HasTemporaryValue(IProperty)

Gets a value indicating if the specified property has a temporary value.

bool HasTemporaryValue(IProperty property)
Function HasTemporaryValue(property As IProperty) As Boolean
Parameters
property
IProperty IProperty

The property to be checked.

Returns
System.Boolean System.Boolean

True if the property has a temporary value, otherwise false.

IsModified(IProperty) IsModified(IProperty)

Gets a value indicating if the specified property is modified. If true, the current value assigned to the property should be saved to the database.

bool IsModified(IProperty property)
Function IsModified(property As IProperty) As Boolean
Parameters
property
IProperty IProperty

The property to be checked.

Returns
System.Boolean System.Boolean

True if the property is modified, otherwise false.

IsStoreGenerated(IProperty) IsStoreGenerated(IProperty)

Gets a value indicating if the specified property should have a value generated by the database.

bool IsStoreGenerated(IProperty property)
Function IsStoreGenerated(property As IProperty) As Boolean
Parameters
property
IProperty IProperty

The property to be checked.

Returns
System.Boolean System.Boolean

True if the property should have a value generated by the database, otherwise false.

SetCurrentValue(IPropertyBase, Object) SetCurrentValue(IPropertyBase, Object)

Gets the value assigned to the property.

void SetCurrentValue(IPropertyBase propertyBase, object value)
Sub SetCurrentValue(propertyBase As IPropertyBase, value As Object)
Parameters
propertyBase
IPropertyBase IPropertyBase

The property to set the value for.

value
System.Object System.Object

The value to set.

ToEntityEntry() ToEntityEntry()

Gets an EntityEntry for the entity being saved. EntityEntry is an API optimized for application developers and IUpdateEntry is optimized for database providers, but there may be instances where a database provider wants to access information from EntityEntry.

EntityEntry ToEntityEntry()
Function ToEntityEntry As EntityEntry
Returns

An EntityEntry for this entity.