Interface ICustomObjectSettings
- Namespace
- ArcanaDevelopment.adTempus.Shared.Extensibility
- Assembly
- ArcanaDevelopment.adTempus.Shared.dll
Interface for classes that implement custom object types.
public interface ICustomObjectSettings : IExtensionProperties
Version
Gets the version of the object.
int Version { get; }Property Value
- int
Remarks
The version is stored by adTempus and passed in to the object when deserializing.
Methods
AddComparisonTo(ObjectComparison, ICustomObjectSettings)
Compare the instance to another instance.
void AddComparisonTo(ObjectComparison comparison, ICustomObjectSettings otherObject)Parameters
| Name | Type | Description |
|---|---|---|
comparison |
ObjectComparison | |
otherObject |
ICustomObjectSettings |
DescribeSettings(IObjectConfigurationReportWriter)
Describes the object's settings for an Object Configuration Report.
void DescribeSettings(IObjectConfigurationReportWriter writer)Parameters
| Name | Type | Description |
|---|---|---|
writer |
IObjectConfigurationReportWriter |
GetDescription()
Gets a user-friendly description of the object (such as key settings).
string GetDescription()Returns
- string
GetReferencedObjects()
Returns a list of the OIDs of all other adTempus objects referenced by this object.
IEnumerable<OID> GetReferencedObjects()Returns
- IEnumerable<OID>
Serialize(int)
Serialize the object for persistence.
string Serialize(int targetVersion)Parameters
| Name | Type | Description |
|---|---|---|
targetVersion |
int |
Returns
- string
Validate(IList<Message>)
Validate the object settings.
void Validate(IList<Message> messages)Parameters
| Name | Type | Description |
|---|---|---|
messages |
IList<Message> | Collection of messages to add validation messages to. |
Remarks
The implementer should perform validation of the object. For each problem found, add a
Message
to the messages collection. Any message with a MessageType of Error or higher will prevent the
object from being saved.