commonMain.cccev.core.certification.command.CertificationFillValuesCommand.kt Maven / Gradle / Ivy

Go to download
package cccev.core.certification.command

import cccev.core.certification.model.CertificationId
import cccev.core.certification.model.RequirementCertificationId
import cccev.s2.concept.domain.InformationConceptIdentifier
import kotlinx.serialization.Serializable
import kotlin.js.JsExport

/**
 * @d2 command
 */
@JsExport
interface CertificationFillValuesCommandDTO {
    /**
     * Id of the certification for which to fill the values.
     */
    val id: CertificationId

    /**
     * Optional RequirementCertification id in which to fill the values. 

     * The given values will only be used to fill the InformationConcepts under it. If null, the whole certification will be filled.
     */
    val rootRequirementCertificationId: RequirementCertificationId?

    /**
     * New values for the certification, mapped by the [identifier][cccev.s2.concept.domain.model.InformationConcept.identifier]
     * of the information concept it provides data for. 

     * If a value had already been provided for one of the information concepts, it will be overwritten with the new specified one.
     * @example "TODO"
     */
    val values: Map
}

/**
 * @d2 inherit
 */
@Serializable
data class CertificationFillValuesCommand(
    override val id: CertificationId,
    override val rootRequirementCertificationId: RequirementCertificationId?,
    override val values: Map
): CertificationFillValuesCommandDTO

/**
 * @d2 event
 */
@JsExport
interface CertificationFilledValuesEventDTO {
    /**
     * Id of the certification to which the values have been added.
     */
    val id: CertificationId

    /**
     * TODO
     */
    val rootRequirementCertificationId: RequirementCertificationId?
}

/**
 * @d2 inherit
 */
@Serializable
data class CertificationFilledValuesEvent(
    override val id: CertificationId,
    override val rootRequirementCertificationId: RequirementCertificationId?
): CertificationFilledValuesEventDTO