Table of Contents

Class ClassOption

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Stores audit, snapshot, and other settings for a class of objects.

[ComVisible(true)]
[Guid("3D002F1D-670A-46D0-9FA6-FF4418587B03")]
public sealed class ClassOption : ObjectBase
Inheritance
object
ClassOption

Properties

AuditRetentionDays

The retention period for audit records.

public int AuditRetentionDays { get; set; }

Property Value

int

Remarks

Set to 0 to use the default retention period

ChangeLogRuleAdd

The ChangeLog rule to apply when objects are created.

public ChangeAuditSetting ChangeLogRuleAdd { get; set; }

Property Value

ChangeAuditSetting

ChangeLogRuleDelete

The ChangeLog rule to apply when objects are deleted.

public ChangeAuditSetting ChangeLogRuleDelete { get; set; }

Property Value

ChangeAuditSetting

ChangeLogRuleEnableDisable

The ChangeLog rule to apply when objects are enabled or disabled (released or held).

public ChangeAuditSetting ChangeLogRuleEnableDisable { get; set; }

Property Value

ChangeAuditSetting

ChangeLogRuleModify

The ChangeLog rule to apply when objects are modified.

public ChangeAuditSetting ChangeLogRuleModify { get; set; }

Property Value

ChangeAuditSetting

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.

DeletionRetentionDays

The retention period for deleted objects.

public int DeletionRetentionDays { get; set; }

Property Value

int

Remarks

Set to 0 to use the default retention period.

SnapshotRetentionOptions

Rule determines how long Snapshot records are retained.

public HistoryRetentionOptions SnapshotRetentionOptions { get; set; }

Property Value

HistoryRetentionOptions

SnapshotRetentionPeriod

The retention period for Snapshot records.

public int SnapshotRetentionPeriod { get; set; }

Property Value

int

SnapshotRuleDelete

The Snapshot rule to apply when objects are deleted.

public ChangeAuditSetting SnapshotRuleDelete { get; set; }

Property Value

ChangeAuditSetting

SnapshotRuleModify

The Snapshot rule to apply when objects are modified.

public ChangeAuditSetting SnapshotRuleModify { get; set; }

Property Value

ChangeAuditSetting

TargetClassID

The class to which these settings apply.

public ClassID TargetClassID { get; }

Property Value

ClassID
See Also

TargetClassName

Gets the name of the class to which the settings apply.

public string TargetClassName { get; }

Property Value

string
See Also

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.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members