Moved isIncoming overloads on RelatedTopicCollection to internal

JeremyCaney · JeremyCaney · commit 5e4047021ca1 · 2020-12-17T13:34:50.000-08:00
The `isIncoming` parameter is used to maintain referential integrity within the topic graph, and is not intended to be called by external implementors. Given this, the methods which use `isIncoming` have been marked as `internal` to avoid confusion.

As part of this, the optional `isDirty` parameter for `SetTopic()` has been moved to the public overload, since that _is_ required externally—and is actively used by `ITopicRepository` implementations.

Note that the (now) internal `SetTopic()` overload's parameter order has changed, to maintain consistency with the public version. As there's only one internal call to it, however, this is not expected to matter.
diff --git a/OnTopic.Data.Sql/SqlDataReaderExtensions.cs b/OnTopic.Data.Sql/SqlDataReaderExtensions.cs
@@ -318,7 +318,7 @@ private static void SetRelationships(this SqlDataReader reader, Dictionary<int,
       /*------------------------------------------------------------------------------------------------------------------------
       | Set relationship on object
       \-----------------------------------------------------------------------------------------------------------------------*/
-      current.Relationships.SetTopic(relationshipKey, related, isIncoming: false, isDirty: false);
+      current.Relationships.SetTopic(relationshipKey, related, isDirty: false);
 
     }
 
diff --git a/OnTopic/Collections/RelatedTopicCollection.cs b/OnTopic/Collections/RelatedTopicCollection.cs
@@ -39,8 +39,8 @@ public class RelatedTopicCollection : KeyedCollection<string, NamedTopicCollecti
     ///   The constructor requires a reference to a <see cref="Topic"/> instance, which the related topics are to be associated
     ///   with. This will be used when setting incoming relationships. In addition, a <see cref="RelatedTopicCollection"/> may
     ///   be set as <paramref name="isIncoming"/> if it is specifically intended to track incoming relationships; if this is not
-    ///   set, then it will not allow incoming relationships to be set via the internal
-    ///   <see cref="SetTopic(String, Topic, Boolean, Boolean?)"/> overload.
+    ///   set, then it will not allow incoming relationships to be set via the internal <see cref=
+    ///   "SetTopic(String, Topic, Boolean?, Boolean)"/> overload.
     /// </remarks>
     public RelatedTopicCollection(Topic parent, bool isIncoming = false) : base(StringComparer.OrdinalIgnoreCase) {
       _parent = parent;
@@ -124,6 +124,17 @@ public void ClearTopics(string relationshipKey) {
     /*==========================================================================================================================
     | METHOD: REMOVE TOPIC
     \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Removes a specific <see cref="Topic"/> object associated with a specific relationship key.
+    /// </summary>
+    /// <param name="relationshipKey">The key of the relationship.</param>
+    /// <param name="topicKey">The key of the topic to be removed.</param>
+    /// <returns>
+    ///   Returns true if the <see cref="Topic"/> is removed; returns false if either the relationship key or the
+    ///   <see cref="Topic"/> cannot be found.
+    /// </returns>
+    public bool RemoveTopic(string relationshipKey, string topicKey) => RemoveTopic(relationshipKey, topicKey);
+
     /// <summary>
     ///   Removes a specific <see cref="Topic"/> object associated with a specific relationship key.
     /// </summary>
@@ -136,7 +147,7 @@ public void ClearTopics(string relationshipKey) {
     ///   Returns true if the <see cref="Topic"/> is removed; returns false if either the relationship key or the
     ///   <see cref="Topic"/> cannot be found.
     /// </returns>
-    public bool RemoveTopic(string relationshipKey, string topicKey, bool isIncoming = false) {
+    internal bool RemoveTopic(string relationshipKey, string topicKey, bool isIncoming = false) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Validate contracts
@@ -227,7 +238,11 @@ public bool RemoveTopic(string relationshipKey, Topic topic, bool isIncoming = f
     /// </remarks>
     /// <param name="relationshipKey">The key of the relationship.</param>
     /// <param name="topic">The topic to be added, if it doesn't already exist.</param>
-    public void SetTopic(string relationshipKey, Topic topic) => SetTopic(relationshipKey, topic, false);
+    /// <param name="isDirty">
+    ///   Optionally forces the collection to a <see cref="NamedTopicCollection.IsDirty"/> state, assuming the topic was set.
+    /// </param>
+    public void SetTopic(string relationshipKey, Topic topic, bool? isDirty = null)
+      => SetTopic(relationshipKey, topic, isDirty, false);
 
     /// <summary>
     ///   Ensures that an incoming <see cref="Topic"/> is associated with the specified relationship key.
@@ -243,7 +258,7 @@ public bool RemoveTopic(string relationshipKey, Topic topic, bool isIncoming = f
     /// <param name="isDirty">
     ///   Optionally forces the collection to a <see cref="NamedTopicCollection.IsDirty"/> state, assuming the topic was set.
     /// </param>
-    public void SetTopic(string relationshipKey, Topic topic, bool isIncoming, bool? isDirty = null) {
+    internal void SetTopic(string relationshipKey, Topic topic, bool? isDirty, bool isIncoming) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Validate contracts
diff --git a/OnTopic/Metadata/ContentTypeDescriptor.cs b/OnTopic/Metadata/ContentTypeDescriptor.cs
@@ -126,7 +126,7 @@ public bool DisableChildTopics {
     ///   </para>
     ///   <para>
     ///     To add content types to the <see cref="PermittedContentTypes"/> collection, use <see
-    ///     cref="RelatedTopicCollection.SetTopic(String, Topic, Boolean, Boolean?)"/>.
+    ///     cref="RelatedTopicCollection.SetTopic(String, Topic, Boolean?)"/>.
     ///   </para>
     /// </remarks>
     public ReadOnlyTopicCollection<ContentTypeDescriptor> PermittedContentTypes {

Original file line number	Diff line number	Diff line change
`@@ -318,7 +318,7 @@ private static void SetRelationships(this SqlDataReader reader, Dictionary<int,`
`318`	`318`	`/*------------------------------------------------------------------------------------------------------------------------`
`319`	`319`	`\| Set relationship on object`
`320`	`320`	`\-----------------------------------------------------------------------------------------------------------------------*/`
`321`		`- current.Relationships.SetTopic(relationshipKey, related, isIncoming: false, isDirty: false);`
	`321`	`+ current.Relationships.SetTopic(relationshipKey, related, isDirty: false);`
`322`	`322`
`323`	`323`	`}`
`324`	`324`