EntityDescriptor Class

Description of modifications done to entities by operations returned in a DataServiceResponse.

Inheritance Hierarchy

System.Object
  System.Data.Services.Client.Descriptor
    System.Data.Services.Client.EntityDescriptor

Namespace:  System.Data.Services.Client
Assembly:  Microsoft.Data.Services.Client (in Microsoft.Data.Services.Client.dll)

Syntax

'Declaration
Public NotInheritable Class EntityDescriptor _
    Inherits Descriptor
'Usage
Dim instance As EntityDescriptor
public sealed class EntityDescriptor : Descriptor
public ref class EntityDescriptor sealed : public Descriptor
[<SealedAttribute>]
type EntityDescriptor =  
    class 
        inherit Descriptor 
    end
public final class EntityDescriptor extends Descriptor

The EntityDescriptor type exposes the following members.

Properties

  Name Description
Public property EditLink Gets or sets the URI that modifies the entity.
Public property EditStreamUri Gets or sets the URI that modifies the binary property data of the entity.
Public property Entity Gets the entity that contains the update data.
Public property ETag Gets an eTag value that indicates the state of data targeted for update since the last call to SaveChanges.
Public property Identity Gets or sets the URI that is the identity value of the entity.
Public property LinkInfos Returns a collection of links that are the relationships in which the entity participates.
Public property OperationDescriptors Gets a collection of operation descriptors associated with the entity.
Public property ParentForInsert Gets the parent entity that is related to the entity.
Public property ParentPropertyForInsert Gets the name of the property of the entity that is a navigation property and links to the parent entity.
Public property ReadStreamUri Gets or sets the URI that accesses the binary property data of the entity.
Public property SelfLink Gets or sets the URI that is used to return the entity resource.
Public property ServerTypeName Gets or sets the name of the type in the data source to which the entity is mapped.
Public property State When overridden in a derived class, gets the state of the object at the time this instance was constructed. (Inherited from Descriptor.)
Public property StreamDescriptors Returns a collection of named binary data streams that belong to the entity.
Public property StreamETag Gets the eTag for the media resource associated with an entity that is a media link entry.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Remarks

The SaveChanges method returns a DataServiceResponse object that contains a series of OperationResponse objects each of which contains a sequence of EntityDescriptor or LinkDescriptor instances that represent changes that were persisted.

For successful operations, the State property of the descriptor will be set to unchanged and the new values for insert and update operations will be merged according to the merge settings.

For operations with errors, the State of the descriptor will remain the same as it was before SaveChanges was called.

If an error occurred and processing stopped during an operation, the State will remain unchanged.

Thread Safety

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

See Also

Reference

System.Data.Services.Client Namespace