IAuditor Interface |
Interface for the auditor to be used with entity instances at runtime. Auditors audit at runtime various actions on entities and allow automatic persistence
of audit information in audit entities when transactions are committed.
Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.6.0.0 (5.6.19.0117)
SyntaxThe IAuditor type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | HasDataToXmlSerialize |
Gets if the auditor object has data which should be Xml serialized. If this property returns false, no serialization (and thus no deserialization)
will take place of the data to XML.
|
Methods| Name | Description | |
|---|---|---|
 | AuditDeleteOfEntity |
Audits the successful delete of an entity from the database
|
| AuditDereferenceOfRelatedEntity |
Audits the successful dereference of related entity from the entity passed in.
|
| AuditDirectDeleteOfEntities |
Audits the successful direct delete of entities in the database
|
| AuditDirectUpdateOfEntities |
Audits the succesful direct update of entities in the database.
|
| AuditEntityFieldGet |
Audits when an entity field's value is succesfully obtained from the passed in entity
|
| AuditEntityFieldSet |
Audits when an entity field is set succesfully to a new value.
|
| AuditInsertOfNewEntity |
Audits the successful insert of a new entity into the database.
|
| AuditLoadOfEntity |
Audits the successful load of an entity from the database
|
| AuditReferenceOfRelatedEntity |
Audits the successful reference of related entity from the entity passed in.
|
| AuditUpdateOfExistingEntity |
Audits the successful update of an existing entity in the database
|
| GetAuditEntitiesToSave |
Gets the audit entities to save. Audit entities contain the audit information stored inside this auditor.
|
| ReadXml(XmlNode) |
Reads the auditor data XML.
|
| ReadXml(XmlReader) |
Reads the auditor data XML.
|
| RequiresTransactionForAuditEntities |
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: true
|
| TransactionCommitted |
The transaction with which the audit entities requested from GetAuditEntitiesToSave were saved.
Use this method to clear any audit data in this auditor as all audit information is persisted successfully.
|
| WriteXml |
Method to serialze audit data to XML. Use the aspects passed in to determine various aspects of the XML format.
If the audit data consists of entity instances, be sure to pass the passed in processedObjectIDs object to the WriteXml routine of IEntity2, so
use the overload of IEntity2.WriteXml() which accepts a reader and the processedObjectIDs. Though it's recommended not to serialize entity objects
in audit data, keep audit data as clean as possible from entity references.
The start element 'Auditor' has already been written, the end element /Auditor will be written for you after this routine.
|
See Also