commonMain.com.saveourtool.save.entities.OrganizationDto.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of save-cloud-common Show documentation

save-cloud-common

The newest version!

package com.saveourtool.save.entities

import com.saveourtool.save.utils.getCurrentLocalDateTime
import com.saveourtool.save.validation.Validatable
import com.saveourtool.save.validation.isValidName
import kotlinx.datetime.LocalDateTime

import kotlinx.serialization.Contextual
import kotlinx.serialization.Serializable

/**
 * @property name organization
 * @property status
 * @property dateCreated date created organization
 * @property avatar
 * @property description
 * @property canCreateContests
 * @property rating
 */
@Serializable
data class OrganizationDto(
    val name: String,
    var status: OrganizationStatus = OrganizationStatus.CREATED,
    @Contextual
    val dateCreated: LocalDateTime = getCurrentLocalDateTime(),
    val avatar: String? = null,
    val description: String = "",
    val canCreateContests: Boolean = false,
    val rating: Long = 0,
) : Validatable {
    /**
     * Validation of organization name
     *
     * @return true if name is valid, false otherwise
     */
    @Suppress("FUNCTION_BOOLEAN_PREFIX")
    fun validateName(): Boolean = name.isValidName()

    /**
     * Validation of an organization
     *
     * @return true if organization is valid, false otherwise
     */
    @Suppress("FUNCTION_BOOLEAN_PREFIX")
    override fun validate(): Boolean = validateName()

    companion object {
        /**
         * Value that represents an empty [OrganizationDto]
         */
        val empty = OrganizationDto(
            name = "",
        )
    }
}