Class ObjectChangeLog

Namespace

ArcanaDevelopment.adTempus.Client

Assembly

ArcanaDevelopment.adTempus.Client.dll

Represents an audit or snapshot record in the change log

public sealed class ObjectChangeLog : ObjectBase

Inheritance

object

ObjectBase

ObjectChangeLog

Remarks

ObjectChangeLog objects cannot be created by the client; they are created on the server in response to snapshot or audit events.

An ObjectChangeLog record can represent:

• An audited change to an object, optionally with a snapshot of the object's state before the change (ObjectOID has a value; HasSnapshot is true)
• A snapshot of an object, unrelated to an audit event (ObjectOID has a value; HasSnapshot is true; ChangeType is SnapshotOnly)
• A user-initiated snapshot of all objects on the server (HasSnapshot is true; ChangeType is SnapshotOnly, IsFullSystemSnapshot is true, IsAutoExport is false)
• An automatically-created daily snapshot of all objects on the server (HasSnapshot is true; ChangeType is SnapshotOnly, IsFullSystemSnapshot is true, IsAutoExport is true)

Use QueryChangeLog(ChangeLogQueryParameters) to retrieve change log records.

For a record with a snapshot use GetSnapshotChanges(OID, Guid, out MessageCollection, out ObjectChangeLog) to create a report of changes made or ViewObjectFromSnapshot(OID, Guid, out MessageCollection) to retrieve an object from the snapshot for viewing.

To retrieve all objects from a snapshot, use SetSourceFromSnapshot(ObjectChangeLog) and then perform an import to return the objects to the client.

Properties

ChangeType

The type of change that was recorded.

public ObjectChangeType ChangeType { get; }

Property Value

ObjectChangeType

ChangeTypeDescription

Gets the text description of the ChangeType.

public string ChangeTypeDescription { get; }

Property Value

string

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

Comments

The comments entered by the user when the change was recorded.

public string Comments { get; }

Property Value

string

CommentsTextType

The TextType for the Comments.

public TextType CommentsTextType { get; }

Property Value

TextType

HasSnapshot

Indicates whether this record has a snapshot.

public bool HasSnapshot { get; }

Property Value

bool

IsAutoExport

Indicates whether this was an automatically-created export.

public bool IsAutoExport { get; }

Property Value

bool

Remarks

IsAutoExport is True if this snapshot was created as an automatic daily snapshot.

IsFullSystemSnapshot

Indicates whether this is a full-system snapshot (rather than a snapshot of a single object).

public bool IsFullSystemSnapshot { get; }

Property Value

bool

IsSystemGenerated

Indicates whether this record was system-generated.

public bool IsSystemGenerated { get; }

Property Value

bool

ObjectDescription

Description of the object that this record applies to.

public string ObjectDescription { get; }

Property Value

string

ObjectOID

The OID of the object this record applies to.

public OID ObjectOID { get; }

Property Value

OID

RecordID

The unique ID for this record.

public Guid RecordID { get; }

Property Value

Guid

SnapshotExpirationDate

The date/time when the snapshot (if any) expires.

[ComVisible(false)]
public DateTime? SnapshotExpirationDate { get; }

Property Value

DateTime?

SnapshotLabel

The label applied for a snapshot.

public string SnapshotLabel { get; }

Property Value

string

TargetClassID

The ClassID ClassID of the affected object.

public ClassID TargetClassID { get; }

Property Value

ClassID

TargetClassName

The ClassName of the affected object.

public string TargetClassName { get; }

Property Value

string

Timestamp

The date/time the record was recorded

public DateTimeOffset Timestamp { get; }

Property Value

DateTimeOffset

UserName

The name of the user who made the change.

public string UserName { get; }

Property Value

string

Remarks

UserName will be empty if IsSystemGenerated is True.

Methods

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

GetSnapshotDescription()

Gets a description of the snapshot, if any

public string GetSnapshotDescription()

Returns

string

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

Name	Type	Description
reportBuilder	IADTObjectConfigurationReportWriter	The report builder to write the object to.

Inherited Members

• ObjectBase.IsDirty
• ObjectBase.IsNew
• ObjectBase.IsStub
• ObjectBase.IsDependent
• ObjectBase.ClassName
• ObjectBase.GetDescriptionWithClassName()
• ObjectBase.GetDescription()
• ObjectBase.ParentObject
• ObjectBase.IsReadOnly
• ObjectBase.BeginEdit()
• ObjectBase.BeginEdit(UndoLevelAction)
• ObjectBase.CommitEdit(Guid)
• ObjectBase.CommitEdit()
• ObjectBase.UndoEdit()
• ObjectBase.UndoEdit(Guid)