This documentation is archived and is not being maintained.

ObjectStateManager Class

Maintains object state and identity management for entity type instances and relationship instances.


Namespace:  System.Data.Objects
Assembly:  System.Data.Entity (in System.Data.Entity.dll)

public class ObjectStateManager

The ObjectStateManager type exposes the following members.

Public methodObjectStateManagerInitializes a new instance of the ObjectStateManager class.

Public propertyMetadataWorkspaceGets the MetadataWorkspace associated with this state manager.

Public methodChangeObjectStateChanges state of the ObjectStateEntry for a specific object to the specified entityState.
Public methodChangeRelationshipState(Object, Object, String, EntityState)Changes the state of the relationship between two entity objects that is specified based on the two related objects and the name of the navigation property.
Public methodChangeRelationshipState(Object, Object, String, String, EntityState)Changes the state of the relationship between two entity objects that is specified based on the two related objects and the properties of the relationship.
Public methodChangeRelationshipState<TEntity>(TEntity, Object, Expression<Func<TEntity, Object>>, EntityState)Changes the state of the relationship between two entity objects that is specified based on the two related objects and a LINQ expression that defines the navigation property.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetObjectStateEntriesReturns a collection of ObjectStateEntry objects for objects or relationships with the given state.
Public methodGetObjectStateEntry(EntityKey)Returns an ObjectStateEntry for the object or relationship entry with the specified key.
Public methodGetObjectStateEntry(Object)Returns an ObjectStateEntry for the specified object.
Public methodGetRelationshipManagerReturns the RelationshipManager that is used by the specified object.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTryGetObjectStateEntry(EntityKey, ObjectStateEntry)Tries to retrieve the corresponding ObjectStateEntry for the object or relationship with the specified EntityKey.
Public methodTryGetObjectStateEntry(Object, ObjectStateEntry)Tries to retrieve the corresponding ObjectStateEntry for the specified Object.
Public methodTryGetRelationshipManagerReturns the RelationshipManager that is used by the specified object.

Public eventObjectStateManagerChangedOccurs when entities are added to or removed from the state manager.

ObjectStateManager tracks query results, and provides logic to merge multiple overlapping query results. It also performs in-memory change tracking when a user inserts, deletes, or modifies objects, and provides the change set for updates. This change set is used by the change processor to persist modifications.

This class is typically used by ObjectContext and not directly in applications.

These examples are based on the Adventure Works Sales Model.

The following example gets the ObjectStateManager from the ObjectContext and uses the state manager to access an object in the context.

int orderId = 43680;

using (AdventureWorksEntities context =
    new AdventureWorksEntities())
    ObjectStateManager objectStateManager = context.ObjectStateManager;
    ObjectStateEntry stateEntry = null;

    var order = (from o in context.SalesOrderHeaders
                 where o.SalesOrderID == orderId
                 select o).First();

    // Attempts to retrieve ObjectStateEntry for the given EntityKey.
    bool isPresent = objectStateManager.TryGetObjectStateEntry(((IEntityWithKey)order).EntityKey, out stateEntry);
    if (isPresent)
        Console.WriteLine("The entity was found");

The following example uses the TryGetObjectStateEntry(EntityKey, ObjectStateEntry) method on the returned ObjectStateManager to get an object based on its entity key.

private static void ApplyItemUpdates(SalesOrderDetail originalItem,
    SalesOrderDetail updatedItem)
    using (AdventureWorksEntities context =
        new AdventureWorksEntities())
        // Check if the ID is 0, if it is the item is new. 
        // In this case we need to chage the state to Added.
        if (updatedItem.SalesOrderDetailID == 0)
            // Because the ID is generated by the database we do not need to
            // set updatedItem.SalesOrderDetailID.
            context.ObjectStateManager.ChangeObjectState(updatedItem, System.Data.EntityState.Added);
            // If the SalesOrderDetailID is not 0, then the item is not new
            // and needs to be updated. Because we already added the 
            // updated object to the context we need to apply the original values.
            // If we attached originalItem to the context 
            // we would need to apply the current values:
            // context.ApplyCurrentValues("SalesOrderDetails", updatedItem);
            // Applying current or original values, changes the state 
            // of the attached object to Modified.
            context.ApplyOriginalValues("SalesOrderDetails", originalItem);

.NET Framework

Supported in: 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.