Interface IADTObjectConfigurationReportWriter
- Namespace
- ArcanaDevelopment.adTempus.Client.ConfigurationReporting
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
Interface implemented by a class that generates configuration reports for objects
public interface IADTObjectConfigurationReportWriter : IObjectConfigurationReportWriterRemarks
The default configuration report builder is used by GetConfigurationReport() and ConfigurationReportGenerator to generate an HTML-based report of all settings and relations for objects.
To generate a report in a different format or for a different use, implement this interface
Methods
AddObjectCollection(string, string, IEnumerable<ADTObject>)
Adds a collection of ADTObjects to the report
void AddObjectCollection(string relationName, string displayName, IEnumerable<ADTObject> collection)Parameters
| Name | Type | Description |
|---|---|---|
relationName |
string | The internal name for the relation |
displayName |
string | The display name for the relation |
collection |
IEnumerable<ADTObject> | The related collection of objects. |
AddRelatedObject(string, string, ADTObject)
Adds a related ADTObject to the report
void AddRelatedObject(string relationName, string displayName, ADTObject relatedObject)Parameters
| Name | Type | Description |
|---|---|---|
relationName |
string | The internal name for the relation |
displayName |
string | The display name for the relation |
relatedObject |
ADTObject | The related object, or null if the relation does not currently have a value |