feat(model-api): added missing IRoleDefinition including subtypes

Author: slisson

model-api/src/commonMain/kotlin/org/modelix/model/api/IChildLink.kt

@@ -21,11 +21,11 @@ import kotlinx.serialization.Serializable
  * Representation of a parent-child relationship between [IConcept]s.
  */
 @Deprecated("Use IChildLinkReference or IChildLinkDefinition")
-interface IChildLink : ILink {
+interface IChildLink : ILink, IChildLinkDefinition {
     /**
      * Specifies if the parent-child relation ship is 1:n.
      */
-    val isMultiple: Boolean
+    override val isMultiple: Boolean
 
     @Deprecated("use .targetConcept")
     val childConcept: IConcept
@@ -42,16 +42,22 @@ interface IChildLink : ILink {
      * If a child role is not ordered, implementations of [[INode.moveChild]] are allowed to fail
      * when instructed to move a node in between existing nodes.
      */
-    val isOrdered
+    override val isOrdered
         get() = true
 
     override fun toReference(): IChildLinkReference = IChildLinkReference.fromIdAndName(getUID(), getSimpleName())
 }
 
+sealed interface IChildLinkDefinition : ILinkDefinition {
+    val isMultiple: Boolean
+    val isOrdered: Boolean
+    override fun toReference(): IChildLinkReference
+}
+
 fun IChildLink?.toReference(): IChildLinkReference = this?.toReference() ?: NullChildLinkReference
 
 @Serializable
-sealed interface IChildLinkReference : IRoleReference {
+sealed interface IChildLinkReference : ILinkReference {
 
     override fun toLegacy(): IChildLink
 

model-api/src/commonMain/kotlin/org/modelix/model/api/ILink.kt

@@ -5,11 +5,21 @@ package org.modelix.model.api
  * A link belongs to one concept and targets another.
  * It can be an [IChildLink] or an [IReferenceLink].
  */
-interface ILink : IRole {
+@Deprecated("Use ILinkReference or ILinkDefinition")
+interface ILink : IRole, ILinkDefinition {
     /**
      * The concept targeted by this link.
      */
+    override val targetConcept: IConcept
+}
+
+sealed interface ILinkDefinition : IRoleDefinition {
     val targetConcept: IConcept
+    override fun toReference(): ILinkReference
+}
+
+sealed interface ILinkReference : IRoleReference {
+    override fun toLegacy(): ILink
 }
 
 abstract class LinkFromName : RoleFromName(), ILink {

model-api/src/commonMain/kotlin/org/modelix/model/api/IProperty.kt

@@ -21,7 +21,7 @@ import kotlinx.serialization.Serializable
  * Representation of a property within an [IConcept].
  */
 @Deprecated("Use IPropertyReference or IPropertyDefinition")
-interface IProperty : IRole {
+interface IProperty : IRole, IPropertyDefinition {
 
     override fun toReference(): IPropertyReference = IPropertyReference.fromIdAndName(getUID(), getSimpleName())
 
@@ -30,6 +30,10 @@ interface IProperty : IRole {
     }
 }
 
+sealed interface IPropertyDefinition : IRoleDefinition {
+    override fun toReference(): IPropertyReference
+}
+
 @Serializable
 sealed interface IPropertyReference : IRoleReference {
 

model-api/src/commonMain/kotlin/org/modelix/model/api/IReferenceLink.kt

@@ -21,7 +21,7 @@ import kotlinx.serialization.Serializable
  * Representation of a non-containment reference link between [IConcept]s.
  */
 @Deprecated("Use IReferenceLinkReference or IReferenceLinkDefinition")
-interface IReferenceLink : ILink {
+interface IReferenceLink : ILink, IReferenceLinkDefinition {
 
     override fun toReference(): IReferenceLinkReference = IReferenceLinkReference.fromIdAndName(getUID(), getSimpleName())
 
@@ -30,8 +30,12 @@ interface IReferenceLink : ILink {
     }
 }
 
+sealed interface IReferenceLinkDefinition : ILinkDefinition {
+    override fun toReference(): IReferenceLinkReference
+}
+
 @Serializable
-sealed interface IReferenceLinkReference : IRoleReference {
+sealed interface IReferenceLinkReference : ILinkReference {
 
     override fun toLegacy(): IReferenceLink
 

model-api/src/commonMain/kotlin/org/modelix/model/api/IRole.kt

@@ -8,27 +8,27 @@ import org.modelix.kotlin.utils.ContextValue
  * It can either be an [IProperty] or an [ILink].
  */
 @Deprecated("Use IRoleReference or IRoleDefinition")
-interface IRole {
+interface IRole : IRoleDefinition {
     /**
      * Returns the concept this role belongs to.
      *
      * @return concept
      */
-    fun getConcept(): IConcept
+    override fun getConcept(): IConcept
 
     /**
      * Returns the uid of this role.
      *
      * @return uid
      */
-    fun getUID(): String
+    override fun getUID(): String
 
     /**
      * Returns the unqualified name of this role.
      *
      * @return simple name
      */
-    fun getSimpleName(): String
+    override fun getSimpleName(): String
 
     @Deprecated("Use getSimpleName() when showing it to the user or when accessing the model use the INode functions that accept an IRole or use IRole.key(...)")
     val name: String get() = RoleAccessContext.getKey(this)
@@ -38,8 +38,16 @@ interface IRole {
      *
      * @return true if this role's value is optional, false otherwise
      */
-    val isOptional: Boolean
+    override val isOptional: Boolean
 
+    override fun toReference(): IRoleReference
+}
+
+sealed interface IRoleDefinition {
+    fun getConcept(): IConcept
+    fun getUID(): String
+    fun getSimpleName(): String
+    val isOptional: Boolean
     fun toReference(): IRoleReference
 }