EntityBase2 Class

CTor

Private CTor for deserialization

Gets / sets the active context this entity is in. Setting this property is adding the entity to the context, and it will make contained entities be added to the passed in context as well. If the entity 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.

Gets the data error info error message set by SetEntityError

Gets the stored error messages per field name. Used for IDataErrorInfo. Use this property in your own code to re-channel the error messages through another interface.

Gets the default name of the root element for XML serialization.

Gets or sets a value indicating whether an edit cycle is in progress, started through databinding

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

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 the classes are used in design-mode in vs.net.

Gets or sets a value indicating whether this instance is deserializing.

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).

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.

The EntityType enum type

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.

Gets the saved fields.

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.

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

Adds the internals to context.

Adds the member collections to the collections queue (base first)

Calls the SetRelatedEntity method on the related entity specified during fast serialization. Used in 1:1 properties of generated entities in the deserialization branch of the setter.

Will check if the entity should refetch itself. Will use the factory pattern trick. Refetching occurs when the fields are marked OutOfSync and thus not dirty.

Checks if the current value of the field on the index specified is null / not defined.

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

Checks if the relation mapped by the property with the name specified is a one way / single sided relation. If the passed in name is null, it will return true if the entity has any single-sided relation

Creates the auditor object for this entity. Routine is called when the entity is constructed. Implement in an entity class to set a particular entity auditor object at construction time. Use this method if you don't want to use LLBLGen Pro's build in dependency injection mechanism.

Creates the authorizer object for this entity. Routine is called when the entity is constructed. Implement in an entity class to set a particular entity authorizer object at construction time. Use this method if you don't want to use LLBLGen Pro's build in dependency injection mechanism.

Creates the concurrency predicate factory for this entity. Routine is called from the entity constructor. Implement in an entity class to set a particular ConcurrentyPredicateFactory object at construction time. Use this method if you don't want to use LLBLGen Pro's build in dependency injection mechanism.

Returns a new EntityCollection instance of the generated type for the specific entity type T

Creates the factory.

Creates a new entity factory instance related to this entity.

Creates entity fields object for this entity. Used in constructor to setup this entity in a polymorphic scenario.

Creates the member entity collections queue.

Creates a new RelationPredicateBucket with the predicates to filter on the related entities represented by the navigator specified.

Creates the ITypeDefaultValue instance used to provide default values for value types which aren't of type nullable(of T)

Creates the validator object for this entity. Routine is called when the entity is constructed. Implement in an entity class to set a particular entity validator object at construction time. Use this method if you don't want to use LLBLGen Pro's build in dependency injection mechanism.

Private CTor for deserialization

Deserializes the member data of this instance.

Method which restores owned data - i.e. considered private to this entity and not shared with any external object

Destructs the synchronization setup between the related entity and this entity, related over the member specified.

Detaches this entity from all referencing entities and resets all references in this entity to other entities, including many-to-many relationships.

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

Produces the actual XML for this entity, recursively. Because it recurses through referenced entities, it keeps track of which objects are processed so cyclic references are not resulting in cyclic recursion and thus a crash.

Compares passed in object with the given object. This is a compare of PK fields. These have to be the same in VALUES. When the values are not the same, or the type is not the same as the current type, false is returned, true otherwise. When this doesn't have any PK fields, all fields are compared. null values are considered as the same value.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Fixes deserialization empty references, because fieldinfo isn't serialized into the data.

Fixes deserialization empty references, because fieldinfo isn't serialized into the data.

A method to call OnPropertyChanged for all fields to signal to bound controls that all fields have been changed.

Gets the additional related data, next to the data returned by GetRelatedData. This method appends the additional related data to the passed in toAppendTo dictionary. Key is the property name, value is the entity object or entity collection represented by the property.

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 EntityField2 with the index fieldIndex.

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 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 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 verbose tracing is switched off for the GeneralSwitch, to prevent performance loss due to reflection activity for trace results which will never be seen.

Gets the entity static meta data instance from the generated type.

Will retrieve all stored entity synchronization information for the passed in entity. If no information is stored, an empty hashtable is returned. All sync info is stored by fieldname

Gets the EntityType value as int for this entity.

Gets the member collections queue from the queue (base first)

Overrides the GetHashCode method. It will calculate a hashcode for this entity using the eXclusive OR of the hashcodes of the primary key fields in this entity. That hashcode is returned. If no primary key fields are present, the hashcode of the base class is returned, which will not be unique.

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 DataAccessAdapter to perform recursive saves. Only 1:n related collections are returned.

ISerializable member. Does custom serialization so event handlers do not get serialized.

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.

Gets the Type of the current instance.

Gets the value of the field with the index specified.

Determines whether the entity has populated member collections

Marks the fields as dirty.

Creates a shallow copy of the current Object.

Audits the successful delete of an entity from the database

Audits the successful dereference of related entity from the entity passed in.

Audits the successful direct delete of entities in the database

Audits the succesful direct update of entities in the database.

Audits when an entity field's value is succesfully obtained from the passed in entity

Audits when an entity field is set succesfully to a new value.

Audits the successful insert of a new entity into the database.

Audits the successful load of an entity from the database

Audits the successful reference of related entity from the entity passed in.

Audits the successful update of an existing entity in the database

This method is called from the DataAccessAdapter method OnBeforeEntitySave(), unless that method is overriden. You can override this OnSave method instead, which allows you to make last minute changes, though keep the logic to do that in the entity.

Called after BeginEdit is succesfully called.

Method which will check if the caller is allowed to delete entities directly in the database.

Method which will check if the caller is allowed to update entities directly in the database.

Called after CancelEdit is succesfully called.

Method which will check if the caller is allowed to delete this existing entity object

Method which will check if the caller is allowed to get the field value with the index specified.

Method which will check if the caller is allowed to fill this entity object with entity data from the database or not.

Method which will check if the caller is allowed to save this existing entity object

Method which will check if the caller is allowed to save this new entity object

Method which will check if the caller is allowed to set the field value with the index specified.

Called at the end of the deserialization constructor. Method is used when this object is deserialized. Override this method to tap into the deserialization sequence. (binary/soap formatter specific).

Called after EndEdit is succesfully called.

Event handler which is called by a related entity after that entity is persisted.

Called when the entity's contents has been changed.

Method which is called right after a field's value has been changed. There are a couple of methods called in the process of setting a field's value. This particular method is solely there to act on a field's value set action. It doesn't raise an event, though it receives the old and new value of the field. Not called if a fieldvalue set action failed. This method is called before changed events are raised.

Returns the FetchNewAuthorizationFailureResultHint as returned by the authorizer. Only called when the CanGetLoad failed (authorization failed, so load was denied)

Called at the end of GetObjectData. Method is used when this object is serialized. Override this method to tap into the serialization sequence. (binary/soap formatter specific).

Called right at the beginning of GetValue(), which is called from an entity field property getter

Called right at the end of GetValue(), which is called from an entity field property getter

Called when InitClassMembers is complete.

Called at the end of the initialization method. Raises Initialized event.

Called at the start of the initialization method. Raises Initializing event.

Called when a property changed value. Call this method to signal databound controls a property has changed.

Method which is called at the end of the SetRelatedEntity() method. Usable to act on the fact that a related entity has been set.

Method which is called at the end of the UnsetRelatedEntity() method. Usable to act on the fact that an entity has been dereferenced as a related entity by the containing entity.

Method which returns true if this auditor expects to have audit entities to persist and therefore needs a transaction. This method is called in the situation when there's no transaction going on though one should be started right before the single-statement action in the case if the auditor has entities to save afterwards. It's recommended to return true if the auditor might have audit entities to persist after an entity save/delete/direct update/direct delete of entities. Default: false

Method which is called in the default clause of the SetRelatedEntityProperty method during the merge process of prefetch path fetches.

Called right at the beginning of SetValue(), which is called from an entity field property setter

Called right at the end of SetValue(), which is called from an entity field property setter

Called after the TransactionCommit method has been finished.

Called after the TransactionRollback method has been finished.

Method to validate the containing entity after it is loaded. This method is called after the entity has been fully loaded.

Method to validate the containing entity right after the entity's save action has been completed and the entity has been refetched (if applicable). Note for adapter users: if the entity wasn't set to be refetched, take into account that reading properties from the containing entity will result in an OutOfSync exception.

Method to validate the containig entity right beforethe entity's delete action will take place.

Method to validate the containing entity right before the save sequence for the entity will start. LLBLGen Pro will call this method right after the containing entity is selected from the save queue to be saved.

Method which will validate, using custom code supplied this class, the field with index fieldIndex if it should accept the specified value. This method is only called when standard checks already succeeded, so value isn't null, and value does match the destination column definition of the EntityField related to fieldIndex.

Performs custom XML deserialization for properties which have the CustomXmlSerializationAttribute. The xmlreader should be used to read the xml from. The reader is positioned on the StartElement of the property which has the name of the property. Check if the element is empty and if not, read till the reader is positioned on the EndElement of the property (which also has the same name). Your override has to set the property's value, using the descriptor's SetValue method.

Performs custom XML serialization for properties which have the CustomXmlSerializationAttribute. Override this method if for some property the data has to be serialized into the output. The xmlwriter should be used to write xml to. You shouldn't emit a startelement with the propertyname, that's already done. Also you shouldn't emit an endelement with the propertyname, that will be done for you. Simply emit XML with the data. Be sure the xml data is valid. You can use the XmlHelper class if necessary.

Performs the dependency injection of related objects. This method will call the Create* methods to create validator, concurrency predicate factory and will then kick in the DependencyInjection functionality build into LLBLGen Pro. This method is called at the end of an entity's InitClassMembers method in the generated code.

Performs the desync setup when an FK field has been changed. The entity referenced based on the FK field will be dereferenced and sync info will be removed.

Routine which is used to perform tasks after a ReadXml() action on this entity instance was performed

Performs the related entity removal.

Method to perform post-fieldvalue set actions, like flagging this object as changed.

Post-processes the value to return from GetValue. Override this method to be able to post-process any value to return from an entity field's property.

Method which is meant to be overriden to pre-process a value right before it is set as a field's new value. In general you don't need to override this method. By default it's a no-op.

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 IEntityCore.WriteXml() and the Xml has to be compatible with the structure of this entity collection.

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 IEntityCore.WriteXml() and the Xml has to be compatible with the structure of this entity collection.

Constructs an object graph with this object as the root from the xml contained by the passed in XmlReader object.

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 IEntityCore.WriteXml() and the Xml has to be compatible with the structure of this entity collection.

Constructs an object graph with this object as the root from the xml contained by the passed in XmlReader object.

Constructs an object graph with this object as the root from the xml contained by the passed in XmlReader object. The method which is called from the explicit implementation of IXmlSerializable.ReadXml(reader).

Removes this instance from the parent collection (if present), to which it was added through databinding

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 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.

Method which stores owned data - i.e. considered private to this entity and not shared with any external object

Sets the _alreadyFetched*Navigatorname* flag for the navigator specified to the value specified.

Sets the discriminator flag if required.

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];

Will set the passed in information as Entity sync information. If there is no sync information stored yet for the related entity then a new entry is created, otherwise it's info is added to the sync information of this entity, if it isn't already present. If there is already sync information for this field stored for another related entity, that information is removed.

Sets the EntityField2 on index fieldIndex to the new value value. Marks also the entityfields2 as dirty.

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 Entity Field on index fieldIndex to the new value value. Marks also the entityfields2 as dirty.

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.

Sets the single related entity navigator to the value (toSet) specified. This isn't done directly, but indirecly by the opposite entity

Sets up the synchronization between the related entity and this entity, related over the member specified.

Sets the value of the field with the index specified to the value specified.

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 value of the field with the index specified to the value specified.

Synchronizes the PK values of the dataSupplier with the related FK values of this entity.

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.

Returns a string that represents the current object.

Will unset (remove) the passed in information as Entity sync information. If there is no sync information stored for the related entity after this info has been removed, the complete hashentry is removed.

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

Method to keep code compilable however which is now marked as obsolete, as people should call ValidateEntity.

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 this entity to XML, recursively. Uses the LLBLGenProEntityName for the rootnode name

Constructs the XML output from the object graph which has this object as the root.

Converts this entity to XML, recursively.

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

Converts this entity to XML

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

Converts this entity to XML, recursively.

Converts this entity to XML

Converts this entity to XML, recursively.

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

Converts this entity to XML

Converts this entity to XML, recursively.

Performs the actual conversion from Xml to entity data.

Performs the actual conversion from Xml to entity data.

Event handler declaration for the event that is fired 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 fired 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 method 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 method 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.

Begins an edit on an object.

Discards changes since the last BeginEdit call.

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

Gets an error message indicating what is wrong with this object.

Populates a SerializationInfo with the data needed to serialize the target object.

Produce the schema, always return null, as the XmlSerializer object otherwise can't handle our code.

Gets the String with the specified column name.

Runs when the entire object graph has been deserialized.

Constructs an object graph with this object as the root from the xml contained by the passed in XmlReader object.

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.

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

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

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

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

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

The custom properties for the type of this entity instance.

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

Gets the fields object of this entity.

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.

Flags me as saved.

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 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 DataAccessAdapter 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.

Returns true if this entity instance is in the middle of a deserialization process, for example during a ReadXml() 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.

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

List of IEntityField2 references which form the primary key. Reads/Affects .Fields.PrimaryKeyFields. If possible use PrimaryKeyFieldInfos instead.

Rejects the changes made to the fields. Used in databinding/service scenarios. Calls RejectChanges 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 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 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.

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)

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()

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

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.

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.