IEntity Interface

Gets / sets the active context this object is in. Setting this property is not adding the object to the context, it will make contained entities be added to the passed in context. If the object is already in a context, setting this property has no effect. Setting this property is done by framework code, use the Context's Add/Get methods to work with contexts and entities.

Gets or sets the Auditor for this entity.

Gets or sets the Authorizer for this entity.

Gets / sets the IConcurrencyPredicateFactory to use for GetConcurrencyPredicate(ConcurrencyPredicateType).

The custom properties for the type of this entity instance.

The internal presentation of the data, which is an EntityFields object, which implements IEntityFields.

The custom properties for the fields of the type of this entity instance. The returned Hashtable contains per fieldname a hashtable of name-value pairs.

Returns true if this entity instance is in the middle of a deserialization process, for example during a ReadXml() call. For internal use only.

Marker for the entity object if the object is 'dirty' (changed, true) or not (false). Affects/reads .Fields.IsDirty.

Marker for the entity object if the object is new and should be inserted when saved (true) or read from the database (false).

Returns true if this entity instance is in the middle of a serialization process, for example during a WriteXml() call. For internal use only.

Gets a value indicating whether this instance is an update only entity. UpdateOnly entities are entities which are 'split off' from the main entity and only update rows in the database, never insert rows.

Returns the full name for this entity, which is important for the DAO to find back persistence info for this entity.

Returns the EntityType enum value for this entity.

Gets the type of the hierarchy this entity is in.

flag which is set when the entity is removed from an entity collection and added to a tracker.

Gets / sets the unique Object ID which is created at runtime when the entity is instantiated. Can be used for external caches.

Flag to check if the ITransactionalElement implementing object is participating in a transaction or not.

Gets the primary key field infos. Similar to PrimaryKeyFields, but this property doesn't trigger field creation.

List of IEntityField references which form the primary key. Reads/Affects .Fields.PrimaryKeyFields

The ITransaction this ITransactionalElement implementing object is participating in. Only valid if ParticipatesInTransaction is true. If set to null, the ITransactionalElement is no longer participating in a transaction.

Gets or sets the TypeDefaultValue provider to use. This object is used to provide default values for value typed fields which are null and not of type Nullable(Of T)

The validator object used to validate the entity on several moments in the entity's life.

Accepts the changes made to the fields. Used in databinding/service scenarios. Calls AcceptChange on the fields in this entity

Begins an edit on an object.

Discards changes since the last BeginEdit call.

Checks whether this instance has pending fk syncs. A pending FK sync is a sync which hasn't been used yet. If an entity has pending FK syncs, it has to be included into a save queue. Only syncs with entities in the passed in queue are considered. If a sync is with an entity which isn't in the passed in queue, the sync isn't honoured anyway, so the fk sync can be ignored.

Determines whether this entity is a subType of the entity represented by the passed in enum value, which represents a value in the EntityType enum

Deletes the Entity from the persistent storage. This method succeeds also when the Entity is not present. Uses, if applicable, the ConcurrencyPredicateFactory to supply the predicate to limit delete activity.

Deletes the Entity from the persistent storage. This method succeeds also when the Entity is not present.

Async variant of Delete. Deletes the Entity from the persistent storage. This method succeeds also when the Entity is not present.

Async variant of Delete. Deletes the Entity from the persistent storage. This method succeeds also when the Entity is not present.

Async variant of Delete(IPredicate). Deletes the Entity from the persistent storage. This method succeeds also when the Entity is not present.

Async variant of Delete(IPredicate). Deletes the Entity from the persistent storage. This method succeeds also when the Entity is not present.

Removes all saved field sets from the internal hashtable, clearing up space. This method is also called when an entity is saved.

Pushes changes since the last BeginEdit or AddNew call into the underlying object.

Loads the data for the excluded fields specified in the list of excluded fields into this entity.

Method which will fire the AfterSave event to signal that this entity is persisted and refetched succesfully.

Routine which will flag all subscribers of the EntityContentsChanged event that this entity's contents is changed.

Gets a list of all the EntityRelation objects the type of this instance has.

Creates the requested predicate of the type specified. If no IConcurrencyPredicateFactory instance is stored in this entity instance, null is returned.

Gets the current value of the EntityField with the index fieldIndex. Will refetch the complete entity's fields from the database if necessary (i.e. the entity is outofsync.).

Gets a collection of related entities referenced by this entity which this entity depends on (this entity is the FK side of their PK fields). These entities will have to be persisted before this entity during a recursive save.

Gets a collection of related entities referenced by this entity which depend on this entity (this entity is the PK side of their FK fields). These entities will have to be persisted after this entity during a recursive save.

Gets the entity description. This string is used in verbose trace messages. It will produce "EntityCore", if the passed in switch flag is false, to prevent performance loss due to reflection activity for trace results which will never be seen.

Gets the entity description. This string is used in verbose trace messages. It will produce "EntityCore", if verbose tracing is switched off for the GeneralSwitch, to prevent performance loss due to reflection activity for trace results which will never be seen.

Returns a new ready to use factory for the type of this instance.

Helper method which performs a lookup in the fields based on the name specified.

Gets the inheritance info for this entity, if applicable (it's then overriden) or null if not.

Gets the inheritance info provider instance of the project this entity instance is located in.

Gets a list of all entity collections stored as member variables in this entity. The contents of the list is used by the Save logic to perform recursive saves. Only 1:n related collections are returned.

Gets all related data objects, stored by name. The name is the field name mapped onto the relation for that particular data element.

Gets the relation objects which represent the relation the fieldName specified is mapped on.

Will fill the entity and its containing members (recursively) with the data stored in the Xml string passed in. The string xmlData has to be filled with Xml in the format written by IEntity.WriteXml() and the Xml has to be compatible with the structure of this entity.

Will fill the entity and its containing members (recursively) with the data stored in the XmlNode passed in. The XmlNode has to be filled with Xml in the format written by IEntity.WriteXml() and the Xml has to be compatible with the structure of this entity.

Refetches the Entity from the persistent storage. Refetch is used to re-load an Entity which is marked "Out-of-sync", due to a save action. Refetching an empty Entity has no effect.

Rejects the changes made to the fields. Used in databinding/service scenarios. Calls RejectChange on the fields in this entity

Replaces the current set of fields with the fields saved under the name specified. If no set of fields is found with the name specified an exception is thrown. Removes the entry after a succesful rollback.

Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. Will not recursively save internal dirty entities. Uses, if applicable, the ConcurrencyPredicateFactory to supply the predicate to limit save activity.

Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. Uses, if applicable, the ConcurrencyPredicateFactory to supply the predicate to limit save activity.

Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. If the entity is new, an insert is done and the updateRestriction is ignored. If the entity is not new, the updateRestriction predicate is used to create an additional where clause (it will be added with AND) for the update query. This predicate can be used for concurrency checks, like checks on timestamp column values. Will not recursively save internal dirty entities.

Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. If the entity is new, an insert is done and the updateRestriction is ignored. If the entity is not new, the updateRestriction predicate is used to create an additional where clause (it will be added with AND) for the update query. This predicate can be used for concurrency checks, like checks on timestamp column values.

Async variant of Save Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. If the entity is new, an insert is done and the updateRestriction is ignored. If the entity is not new, the updateRestriction predicate is used to create an additional where clause (it will be added with AND) for the update query. This predicate can be used for concurrency checks, like checks on timestamp column values.

Async variant of Save(Boolean) Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. If the entity is new, an insert is done and the updateRestriction is ignored. If the entity is not new, the updateRestriction predicate is used to create an additional where clause (it will be added with AND) for the update query. This predicate can be used for concurrency checks, like checks on timestamp column values.

Async variant of Save Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. If the entity is new, an insert is done and the updateRestriction is ignored. If the entity is not new, the updateRestriction predicate is used to create an additional where clause (it will be added with AND) for the update query. This predicate can be used for concurrency checks, like checks on timestamp column values.

Async variant of Save(IPredicate) Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. If the entity is new, an insert is done and the updateRestriction is ignored. If the entity is not new, the updateRestriction predicate is used to create an additional where clause (it will be added with AND) for the update query. This predicate can be used for concurrency checks, like checks on timestamp column values.

Async variant of Save(Boolean) Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. If the entity is new, an insert is done and the updateRestriction is ignored. If the entity is not new, the updateRestriction predicate is used to create an additional where clause (it will be added with AND) for the update query. This predicate can be used for concurrency checks, like checks on timestamp column values.

Async variant of Save(IPredicate, Boolean) Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. If the entity is new, an insert is done and the updateRestriction is ignored. If the entity is not new, the updateRestriction predicate is used to create an additional where clause (it will be added with AND) for the update query. This predicate can be used for concurrency checks, like checks on timestamp column values.

Async variant of Save(IPredicate) Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. If the entity is new, an insert is done and the updateRestriction is ignored. If the entity is not new, the updateRestriction predicate is used to create an additional where clause (it will be added with AND) for the update query. This predicate can be used for concurrency checks, like checks on timestamp column values.

Async variant of Save(IPredicate, Boolean) Saves the Entity class to the persistent storage. It updates or inserts the entity, which depends if the entity was originally read from the database. If the entity is new, an insert is done and the updateRestriction is ignored. If the entity is not new, the updateRestriction predicate is used to create an additional where clause (it will be added with AND) for the update query. This predicate can be used for concurrency checks, like checks on timestamp column values.

Saves the current set of fields under the name specified in an internal hashtable. All data inside the field objects is preserved. If there is already a set of fields saved under the name specified, that set of fields is overwritten.

Sets the error message which is returned by IDataErrorInfo.Error

Sets the error message for the field specified. If there's already a message stored for this field, it's overwritten unless append is set to true, which appends the message to the existing error using a semi-colon as separator. The message stored is returned by IDataErrorInfo[fieldName];

Sets the EntityField on index fieldIndex to the new value value. Marks also the entityfields as dirty. Will refetch the complete entity's fields from the database if necessary (i.e. the entity is outofsync.).

Sets the EntityField with the name fieldName to the new value value. Marks also the entityfields as dirty. Will refetch the complete entity's fields from the database if necessary (i.e. the entity is outofsync.).

Sets the internal parameter related to the fieldname passed to the instance relatedEntity.

Sets the related entity property to the entity specified. If the property is a collection, it will add the entity specified to that collection.

Returns true if the current value for the field with the fieldIndex passed in represents null/not defined, false otherwise. Should not be used for testing if the original value (read from the db) is NULL

Returns true if the original value for the field with the fieldIndex passed in, read from the persistent storage was NULL, false otherwise. Should not be used for testing if the current value is NULL, use TestCurrentFieldValueForNull(Enum) for that.

When the ITransaction in which this element participates is commited, this element can succesfully finish actions performed by this element. This method is called by ITransaction, you should not call it by yourself. When this element doesn't participate in a transaction it finishes the actions itself, calling this method is not needed.

When the ITransaction in which this element participates is rolled back, this element has to roll back its internal variables. This method is called by ITransaction, you should not call it by yourself.

Unsets the internal parameter related to the fieldname passed to the instance relatedEntity. Reverses the actions taken by SetRelatedEntity()

Unsets the internal parameter related to the fieldname passed to the instance relatedEntity. Reverses the actions taken by SetRelatedEntity()

General validation method which isn't used by the LLBLGen Pro framework, but can be used by your own code to validate an entity at any given moment.

Converts the data inside inside this entity into XML, recursively.

Converts the data inside inside this entity into XML, recursively.

Converts the data inside inside this entity into XML, recursively.

Converts this entity to XML, recursively.

Converts the data inside inside this entity into XML, recursively.

Converts this entity to XML, recursively.

Converts this entity to XML, recursively. Uses the LLBLGenProEntityName for the rootnode name

Converts this entity to XML, recursively.

Event handler declaration for the event that is raised each time this entity is persisted. Related entities can subscribe to this event to start housekeeping actions, like syncing internal FK fields with the PK fields of this entity.

Event handler declaration for the event that is raised each time the one of values of this entity are changed. The event does not contain the value / field which is changed, it only signals subscribers the entity is changed and the subscriber should act accordingly, f.e. fire a ListChanged event.

Event which is raised at the end of the initialization routine of the entity. This event is also raised if the entity is pre-filled with a filled EntityFields(2) object. In your handler, check the State property of the entity Fields to see if you're dealing with a new entity or with an entity which is new, but pre-initialized with filled field objects.

Event which is raised at the start of the initialization routine of the entity. The entity is clean and has no entity fields object yet.

Event fired when a field / property is changed. To fire this event from a derived class, call OnPropertyChanged.