net.nemerosa.ontrack.model.structure.EntityDataService.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ontrack-model Show documentation

Ontrack module: ontrack-model

There is a newer version: 4.4.5

package net.nemerosa.ontrack.model.structure

import com.fasterxml.jackson.databind.JsonNode

/**
 * This service allows to store and retrieve arbitrary data with some
 * [project entities][net.nemerosa.ontrack.model.structure.ProjectEntity].
 */
interface EntityDataService {

    /**
     * Stores boolean data
     */
    fun store(entity: ProjectEntity, key: String, value: Boolean)

    /**
     * Stores integer data
     */
    fun store(entity: ProjectEntity, key: String, value: Int)

    /**
     * Stores string data
     */
    fun store(entity: ProjectEntity, key: String, value: String)

    /**
     * Stores arbitrary data as JSON
     */
    fun store(entity: ProjectEntity, key: String, value: Any)

    /**
     * Retrieves data as boolean
     */
    fun retrieveBoolean(entity: ProjectEntity, key: String): Boolean?

    /**
     * Retrieves data as integer
     */
    fun retrieveInteger(entity: ProjectEntity, key: String): Int?

    /**
     * Retrieves arbitrary data as string
     */
    fun retrieve(entity: ProjectEntity, key: String): String?

    /**
     * Retrieves arbitrary data as JSON
     */
    fun retrieveJson(entity: ProjectEntity, key: String): JsonNode?

    /**
     * Retrieves arbitrary data as JSON
     */
    fun  retrieve(entity: ProjectEntity, key: String, type: Class): T?

    /**
     * Checks if the given [entity] has a value associated with the [key]
     */
    fun hasEntityValue(entity: ProjectEntity, key: String): Boolean

    /**
     * Looks for a linked entry using a text value
     */
    fun findEntityByValue(type: ProjectEntityType, key: String, value: JsonNode): ProjectEntityID?

    /**
     * Deletes data
     *
     * @param entity Entity to delete data from
     * @param key    Key to delete
     */
    fun delete(entity: ProjectEntity, key: String)

    /**
     * Loads some data, processes it and saves it back
     */
    fun  withData(entity: ProjectEntity, key: String, type: Class, processFn: (T) -> T)

}