AuditTrailService Members
The service that the Audit Trail Module uses to monitor object changes and log this information. You can use the static Instance property to access this service and customize its behavior.Properties
| Name | Description |
|---|---|
| AuditDataStore | Stores AuditDataItem objects that contain information about object changes. |
| Instance static | Provides access to the instance of the AuditTrailService. Use this property to access AuditTrailService‘s settings. |
| ObjectAuditingMode | Specifies the object auditing mode. |
| ObjectAuditProcessorsFactory | Provides access to the factory that creates ObjectAuditProcessor for a particular object auditing mode. |
| Settings | Provides access to the service’s settings. These settings allow you to customize the list of objects and properties that should be audited. |
| TimestampStrategy | Specifies the Audit Timestamp Strategy. |
Methods
| Name | Description |
|---|---|
| AddCustomAuditData(Session, AuditDataItem) | Adds custom data (information on events that are not audited) to the audit log. |
| BeginObjectsAudit(Session, ObjectAuditingMode, Object[]) | Starts auditing the specified objects according to auditingMode. |
| BeginObjectsAudit(Session, Object[]) | Starts auditing the specified objects in Full object auditing mode. |
| BeginSessionAudit(Session, AuditTrailStrategy, ObjectAuditingMode) | Starts auditing changes made to the object within the specified session. |
| BeginSessionAudit(Session, AuditTrailStrategy) | Starts auditing object changes made within the specified session. |
| EndSessionAudit(Session) | Stops auditing object changes made within the specified session. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetStrategy(Session) | Gets the audit strategy for the specified session. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| IsSessionAudited(Session) | Indicates whether the Audit Trail Module audits object changes within the specified session. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| SaveAuditData(Session) | Saves AuditDataItem objects to the database. Call this method when you add custom audit data to the log. |
| SetXPDictionaries(IList<XPDictionary>) | For internal use. |
| SetXPDictionary(XPDictionary) | For internal use. |
| ToString() | Returns a string that represents the current object. Inherited from Object. |
Events
| Name | Description |
|---|---|
| CustomCreateObjectAuditProcessorsFactory | Handle this event to replace a default ObjectAuditProcessor for a particular object auditing mode with a custom processor. |
| CustomizeAuditOperationTypeFilter | Occurs after a business object is changed and before the corresponding AuditDataItem object is saved. |
| CustomizeAuditTrailSettings | This event is raised when an application’s setup is complete. Handle this event to use the default settings for the Audit Trail Module. |
| CustomizeSessionAuditingOptions | For internal use. |
| QueryCurrentUserName | Occurs before AuditDataItem objects are saved. Handle this event to get the current user name in applications that do not use the Security System. |
| SaveAuditTrailData | Occurs before new AuditDataItem objects are saved to the database. Handle this event to configure how the Audit Trail Module saves information. |
See Also