AddEntity Method (EntityManager)

Adds a newly created entity to the EntityManager cache.

Syntax

Visual Basic
C#

'Declaration
 
Public Sub AddEntity( _
   ByVal entity As Object _
)

'Usage
 
Dim instance As EntityManager
Dim entity As Object
 
instance.AddEntity(entity)

public void AddEntity( 
   object entity
)

Parameters

entity: Entity to be added.

Exceptions

Exception	Description
System.ArgumentException	Entity already belongs to another EntityManager

Remarks

There is no difference between AddEntity and EntityAspect.AddToManager. Use either method to add a business object created by the CreateEntity method to the EntityManager cache. The object must have a "detached" EntityState. The added entity will have an entity state of "Added" after this method completes.

If the entity has an auto-incrementing EntityKey, the GenerateId method is called to create a temporary ID. See the Developer Guide for more information on custom ID generation.

The EntityChanging and EntityChanged events fire when this method executes with an EntityAction of EntityAction.Add.

Example

DomainModelEntityManager mgr = new DomainModelEntityManager();

// Retrieve an order
Order order = mgr.Orders.FirstOrNullEntity(o=> o.OrderID == 1);
// Retrieve a product
Product product = mgr.Products.FirstOrNullEntity(p => p.ProductID == 1);

// Create an OrderDetail 
OrderDetail dtl = mgr.CreateEntity<OrderDetail>();
// assign key fields
dtl.OrderSummary = order;
dtl.Product = product;

// add the OrderDetail to the EntityManager cache
DebugFns.WriteLine("entity state before add = " + dtl.EntityState);
dtl.AddToManager();
DebugFns.WriteLine("entity state after add = " + dtl.EntityState);

Requirements

Target Platforms: 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

Reference

EntityManager Class
EntityManager Members
AddToManager Method
CreateEntity(Type) Method
AddEntities Method