Interface IObjectConfigurationReportWriter

Namespace

ArcanaDevelopment.adTempus.Shared

Assembly

ArcanaDevelopment.adTempus.Shared.dll

Interface implemented by a class that generates configuration reports for objects

public interface IObjectConfigurationReportWriter

Remarks

See Remarks under IADTObjectConfigurationReportWriter for more information

Methods

AddCollection(string, string, bool)

Adds a new collection of values to the report

ICollectionReportWriter AddCollection(string relationName, string displayName, bool useSequenceNumbers)

Parameters

Name	Type	Description
relationName	string	The internal name for the collection
displayName	string	The display name for the collection
useSequenceNumbers	bool	Indicates whether sequence numbers should be automatically added to the report

Returns

ICollectionReportWriter

Remarks

This method returns a reference to an ICollectionReportWriter representing the collection. The caller should AddItem(object) for each item in the collection to add its value to the report.

AddContainedObject(string, string, string)

Adds a contained object

IObjectConfigurationReportWriter AddContainedObject(string relationName, string relationDisplayName, string objectHeader)

Parameters

Name	Type	Description
relationName	string	The internal name for the relation
relationDisplayName	string	The display name for the relation
objectHeader	string	An optional heading to appear above the output for the contained object

Returns

IObjectConfigurationReportWriter

Remarks

A contained object is an object that is a constituent part of the parent object.

This method returns a reference to a new IObjectConfigurationReportWriter, which should be passed to the contained object so it can add itself to the report.

AddField(string, string, object)

Adds a field to the report

void AddField(string fieldName, string displayName, object value)

Parameters

Name	Type	Description
fieldName	string	The internal name for the field
displayName	string	The display name for the field
value	object	The current value of the field

AddReferencedObject(string, string, OID)

Adds a referenced object

void AddReferencedObject(string fieldName, string displayName, OID value)

Parameters

Name	Type	Description
fieldName	string	The internal name for the relation
displayName	string	The display name for the relation
value	OID	The OID of the current value of the relation

Remarks

A referenced object is referenced but not owned (contained) by the caller.