EntityDescriptor Class

Article
05/29/2013

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

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	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.

Share via